Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use https + fix some broken links + reduce redirects #637

Merged
merged 15 commits into from
Dec 3, 2017
9 changes: 4 additions & 5 deletions source/about/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ API
Contributor
Someone who contributes code to the SpongePowered projects.
Coremod
A Forge mod that is loaded before any Mojang classes are loaded. The purpose of a CoreMod is to patch actual Minecraft
code. http://www.minecraftforge.net/wiki/Core_Mod
A CoreMod is a Forge mod that loads before Mojang classes are loaded, allowing it to modify native Minecraft code via
Access Transformers, ASM class modification, or other Java bytecode manipulation.
Crowdin
A web-based translation system for documentation. SpongeDocs uses it to provide translated Docs in many languages.
https://crowdin.com/project/sponge-docs
Expand All @@ -29,7 +29,7 @@ FLARD
It is green, edible, and explosive. Leave it alone and it will leave you alone.
Forge
A long-standing Minecraft modding API, with its own installer. Forge enables mods in single player, LAN, and on
dedicated servers. http://www.minecraftforge.net/wiki/
dedicated servers. https://mcforge.readthedocs.io/en/latest/
GitHub
A free public web-based system for sharing code and creating projects. https://github.com/
Implementation
Expand All @@ -54,7 +54,7 @@ Ore
The Official Sponge plugin hosting site, not ready yet. Use the Sponge Forums instead.
Patreon
A Service that allows for donations to projects and organizations. If you want to support Sponge, this is the place to
look at! `Sponge Patreon Donation Page <https://www.patreon.com/Sponge?ty=h>`__
look at! `Sponge Patreon Donation Page <https://www.patreon.com/Sponge>`__
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

may have been a value in the past, but I couldn't find any trace of it in the Patreon docs

Plugin
A Minecraft mod that extends and changes Minecraft via the SpongeAPI, usable only on Sponge servers.
Project Leaders
Expand All @@ -78,7 +78,6 @@ Sponge Forums
regularly. https://forums.spongepowered.org/
Sponge Foundation
The financial side of the project, a separate entity that accepts, manages and distributes donations.
http://spongefoundation.org/
SpongeVanilla
An implementation of Sponge API that runs on Vanilla Minecraft (and not Forge).
Spongie
Expand Down
2 changes: 1 addition & 1 deletion source/about/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The History of Spongie
----------------------

Spongie first appeared in #Sponge on Esper.NET around September 2014. She was created and posted by
`DragonsPainter <http://dragonspainter.deviantart.com/>`__. Strad, another user, felt that Spongie would look better with
`DragonsPainter <https://dragonspainter.deviantart.com/>`__. Strad, another user, felt that Spongie would look better with
a moogle-like antenna, a Forge furnace instead of a Cauldron and replaced the Spigot with Spout. An anonymous user then
removed all labels and introduced her as the icon and background logo for the Sponge reddit section.

Expand Down
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@

javadoc_links = {
'https://jd.spongepowered.org/%s/' % release: ['org.spongepowered.api'],
'http://zml2008.github.io/configurate/apidocs/': ['ninja.leaping.configurate'],
'http://configurate.aoeu.xyz/apidocs/': ['ninja.leaping.configurate'],
'https://docs.oracle.com/javase/8/docs/api/': ['java'],
'https://google.github.io/guava/releases/17.0/api/docs/': ['com.google.common']
}
Expand Down
2 changes: 1 addition & 1 deletion source/contributing/implementation/codestyle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Code Conventions
``null`` in the API
* Method parameters accepting ``null`` must be annotated with ``@Nullable`` (from javax.*), all methods and parameters
are ``@Nonnull`` by default.
* Use `Google Preconditions <https://code.google.com/p/guava-libraries/wiki/PreconditionsExplained>`_ for null- and
* Use `Google Preconditions <https://github.com/google/guava/wiki/PreconditionsExplained>`_ for null- and
argument checking.

The Gist
Expand Down
2 changes: 1 addition & 1 deletion source/contributing/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Versioning System and Repository Branch Layout
==============================================

With the release for beta we've moved the SpongeAPI versioning to semantic versioning (see http://semver.org/).
With the release for beta we've moved the SpongeAPI versioning to semantic versioning (see https://semver.org/).
This change means that every time that we make a release we have to increment the version according to the rules
of semver.

Expand Down
12 changes: 6 additions & 6 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Welcome to SpongeDocs, the official documentation for the open-source `Sponge <h

The SpongeAPI is your all new plugin API for Minecraft. You can run it on a plain vanilla server (as SpongeVanilla) or
on your fully modded MinecraftForge server (as SpongeForge). Grab your copy
`here <https://spongepowered.org/downloads>`_.
`here <https://www.spongepowered.org/downloads>`_.

Not sure what you're looking for? Try our :doc:`about/index` section, which contains a short :doc:`about/introduction`,
our :doc:`about/faq` and an article about :doc:`about/structure`.
Expand All @@ -29,7 +29,7 @@ or visit their repositories on GitHub:
.. note::

Sponge development is ongoing. Beta and Experimental builds of both SpongeForge and SpongeVanilla are currently
available for `download <https://spongepowered.org/downloads>`_.
available for `download <https://www.spongepowered.org/downloads>`_.

Contents
========
Expand Down Expand Up @@ -121,13 +121,13 @@ Links
:maxdepth: 2
:titlesonly:

- `Sponge Homepage <https://spongepowered.org>`_
- `Sponge Homepage <https://www.spongepowered.org>`_
- `Sponge Forums <https://forums.spongepowered.org>`_
- `Sponge Discord <https://discord.gg/PtaGRAs>`_
- `Sponge Downloads <https://spongepowered.org/downloads>`_
- `Sponge Downloads <https://www.spongepowered.org/downloads>`_
- `SpongeAPI Issue Tracker <https://github.com/SpongePowered/SpongeAPI/issues?q=>`_
- `SpongeAPI Javadocs <https://jd.spongepowered.org>`_
- `Sponge Twitter <https://twitter.com/SpongePowered>`_
- `Sponge Subreddit <https://reddit.com/r/SpongeProject>`_
- `Sponge Subreddit <https://www.reddit.com/r/spongeproject>`_
- `Sponge GitHub <https://github.com/SpongePowered>`_
- `Sponge Patreon Donation Page <https://www.patreon.com/Sponge?ty=h>`_
- `Sponge Patreon Donation Page <https://www.patreon.com/Sponge>`_
2 changes: 1 addition & 1 deletion source/plugin/blocks/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ additional way that *some* blocks have data: tile entities.
Tile entities themselves are Java objects (like a `Chest` class). Normally, Minecraft code would access data in a tile
entity by getting its instance and then calling it methods or fields, like a regular object
(``world.getTileEntity(position).getInventory()``). When tile entities need to be written to the save file, they are
stored in the `NBT format <http://minecraft.gamepedia.com/NBT_format>`_.
stored in the `NBT format <https://minecraft.gamepedia.com/NBT_format>`_.

.. tip::

Expand Down
2 changes: 1 addition & 1 deletion source/plugin/buildsystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ your plugin. Continue at :doc:`plugin-identifier` for choosing an identifier for
.. _`Maven Users Centre`: https://maven.apache.org/users/index.html
.. _`Maven in 5 Minutes`: https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html
.. _`Maven Getting Started Guide`: https://maven.apache.org/guides/getting-started/index.html
.. _`SpongeAPI Download Page`: https://repo.spongepowered.org/maven/org/spongepowered/spongeapi/
.. _`SpongeAPI Download Page`: https://www.spongepowered.org/downloads/spongeapi/
17 changes: 9 additions & 8 deletions source/plugin/data/custom/datamanipulators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Custom DataManipulators
=======================

.. javadoc-import::
org.spongepowered.api.event.game.state.GameInitializationEvent
org.spongepowered.api.data.DataManager
org.spongepowered.api.data.DataRegistration
org.spongepowered.api.data.DataSerializable
Expand All @@ -18,13 +17,14 @@ Custom DataManipulators
org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleData
org.spongepowered.api.data.manipulator.mutable.tileentity.FurnaceData
org.spongepowered.api.data.value.ValueFactory
org.spongepowered.api.data.value.mutable.Value
org.spongepowered.api.data.value.mutable.BoundedValue
org.spongepowered.api.data.value.mutable.MapValue
org.spongepowered.api.data.value.mutable.BoundedComparableValue
org.spongepowered.api.data.value.mutable.Value
org.spongepowered.api.data.value.ValueContainer
org.spongepowered.api.inventory.ItemStack
org.spongepowered.api.event.game.state.GameInitializationEvent
org.spongepowered.api.item.inventory.ItemStack
org.spongepowered.api.util.TypeTokens
java.util.Comparable
java.lang.Comparable
java.util.Comparator
com.google.common.reflect.TypeToken

Expand All @@ -35,9 +35,10 @@ create a separate API for your custom data. Generally speaking it's best to sepa

You'll want to define an API method for each "unit" your data, such as a ``String``, ``int``, :javadoc:`ItemStack` or
a custom type like ``Home``. These units will be wrapped in a :javadoc:`Value`, which will allow it to be accessed
with :javadoc:`Key`\ s. There are various extensions of ``Value`` depending on which object will be represented, such
as :javadoc:`MapValue` which provides the standard map operations, or :javadoc:`BoundedComparableValue` which can set
limits on the upper and lower bound of an :javadoc:`Comparable` objects like integers.
with :javadoc:`Key`\s. There are various extensions of ``Value`` depending on which object will be represented, such
as :javadoc:`MapValue` which provides the standard map operations, or :javadoc:`BoundedValue` which can set
limits on the upper and lower bound of the value (like integers). The bounds of the values are verified using a
:javadoc:`Comparator`.

Now, pick which of the :javadoc:`AbstractData` types you'll extend from. While you could implement from scratch, these
abstract types remove a *lot* of the work that needs to be done implementing the required methods. A full list can be
Expand Down
4 changes: 2 additions & 2 deletions source/plugin/data/custom/serialization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Serializing Custom Data
.. javadoc-import::
org.spongepowered.api.data.DataHolder
org.spongepowered.api.data.DataQuery
org.spongepowered.api.data.DataSerializable
org.spongepowered.api.data.manipulator.DataManipulator
org.spongepowered.api.data.manipulator.DataManipulatorBuilder
org.spongepowered.api.data.persistence.AbstractDataBuilder
org.spongepowered.api.data.persistence.DataBuilder
org.spongepowered.api.data.persistence.DataContentUpdater
org.spongepowered.api.data.persistence.DataManipulator
org.spongepowered.api.data.persistence.DataManipulatorBuilder
org.spongepowered.api.data.persistence.DataTranslator
org.spongepowered.api.data.persistence.DataTranslators
org.spongepowered.api.data.serialization.DataSerializable

Without a method for serializing and deserializing, your data will not persist across restarts. Sponge has a few different
ways to serialize/deserialize data based on the type of data:
Expand Down
8 changes: 4 additions & 4 deletions source/plugin/event/listeners.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Event Listeners
org.spongepowered.api.event.EventManager
org.spongepowered.api.event.Listener
org.spongepowered.api.event.Order
org.spongepowered.api.event.SpongeEventFactory
org.spongepowered.api.event.block.ChangeBlockEvent
org.spongepowered.api.event.block.ChangeBlockEvent.Break
org.spongepowered.api.event.cause.Cause
Expand Down Expand Up @@ -69,7 +68,7 @@ the class containing the event listeners.


Dynamically Registering Event Listeners
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Some plugins (such as scripting plugins) may wish to dynamically register an event listener. In that case the event
listener is not a method annotated with ``@Listener``, but rather a class implementing the ``EventListener`` interface.
Expand Down Expand Up @@ -131,7 +130,7 @@ event listeners, including those registered with ``@Listener`` annotations.
.. _about_listener:

About @Listener
~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~

The ``@Listener`` annotation has a few configurable fields:

Expand Down Expand Up @@ -181,7 +180,8 @@ The method returns ``true`` if the event was cancelled, ``false`` if not.
Firing Sponge Events
~~~~~~~~~~~~~~~~~~~~

It is possible to generate instances of built-in events with the static :javadoc:`SpongeEventFactory`. The events
It is possible to generate instances of built-in events with the static ``SpongeEventFactory``. This class is
automatically generated so there are no Javadocs. Use your IDE's autocompletion to list the existing methods. The events
created by the ``SpongeEventFactory`` are then passed to :javadoc:`EventManager#post(Event)`.

Example: Firing LightningEvent
Expand Down
4 changes: 2 additions & 2 deletions source/plugin/internals/mcp-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Vanilla Workspace
repositories {
maven {
name = 'forge'
url = 'http://files.minecraftforge.net/maven'
url = 'https://files.minecraftforge.net/maven'
}
}

Expand Down Expand Up @@ -70,7 +70,7 @@ Forge Workspace
repositories {
maven {
name = 'forge'
url = 'http://files.minecraftforge.net/maven'
url = 'https://files.minecraftforge.net/maven'
}
}

Expand Down
2 changes: 1 addition & 1 deletion source/plugin/plugin-meta.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ If you're not using a build system you need to manually enable annotation proces
Build system integration
------------------------

If you're using Gradle, `SpongeGradle <start/project/gradle>`_ will provide additional integration for Gradle and
If you're using Gradle, `SpongeGradle <https://github.com/SpongePowered/SpongeGradle>`_ will provide additional integration for Gradle and
plugin metadata. For example, it will automatically include the project version defined in the Gradle build script in
your plugin metadata. See :doc:`project/gradle` for details.

Expand Down
2 changes: 1 addition & 1 deletion source/plugin/project/maven.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ required properties, but optional properties must be specified on the command li

.. code-block:: bash

$ mvn archetype:generate -DarchetypeArtifactId=sponge-plugin-archetype -DarchetypeGroupId=org.spongepowered -DarchetypeRepository=http://repo.spongepowered.org/maven -DarchetypeVersion=1.2 -DgithubProject=waylon531/spongeparty
$ mvn archetype:generate -DarchetypeArtifactId=sponge-plugin-archetype -DarchetypeGroupId=org.spongepowered -DarchetypeRepository=https://repo.spongepowered.org/maven -DarchetypeVersion=1.2 -DgithubProject=waylon531/spongeparty

The first four arguments specify where maven will find the archetype and which version to use. The
``-DgithubProject=waylon531/spongeparty`` parameter is an optional property for the generated project and can be left
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Text can be represented by using a special character indicating a formatting *of
indicating the specific formatting to be used. In the SpongeAPI, there are two different characters that are supported
by default: the ampersand (&) and the section character (§).

Both formatting schemes use the codes found at the `Minecraft Wiki <http://minecraft.gamepedia.com/Formatting_codes>`_.
Both formatting schemes use the codes found at the `Minecraft Wiki <https://minecraft.gamepedia.com/Formatting_codes>`_.
It is important to note that the Minecraft Wiki only displays the use of the section character (§), but the same codes
work with the ampersand (&) as well.

Expand Down
4 changes: 2 additions & 2 deletions source/plugin/text/representations/json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
JSON Format
===========

JSON is `JavaScript Object Notation <http://www.json.org/>`_, a "light-weight data-interchange format" that is "easy
JSON is `JavaScript Object Notation <https://www.json.org/>`_, a "light-weight data-interchange format" that is "easy
for humans to read and write" and "for machines to parse and generate". The
`Minecraft Wiki <http://minecraft.gamepedia.com/Commands#Raw_JSON_Text>`_ details the structure of text represented
`Minecraft Wiki <https://minecraft.gamepedia.com/Commands#Raw_JSON_Text>`_ details the structure of text represented
in JSON.

For example, the text "Hello World!", formatted with the color red and an underline would have the following representation
Expand Down
2 changes: 1 addition & 1 deletion source/plugin/text/text.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ useful when creating minigame plugins, but have a broad range of applications.

.. tip::

Read this `Minecraft wiki article <http://minecraft.gamepedia.com/Commands#Target_selectors>`__ for help understanding
Read this `Minecraft wiki article <https://minecraft.gamepedia.com/Commands#Target_selectors>`__ for help understanding
what target selectors are in Minecraft, and how to use them.

To use selectors in text, you must use the :javadoc:`Selector.Builder` interface. This is illustrated in the example
Expand Down
2 changes: 1 addition & 1 deletion source/plugin/workspace/idea.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ Git Integration

JetBrains offers documentation on Git integration:

https://www.jetbrains.com/idea/help/using-git-integration.html
https://www.jetbrains.com/help/idea/using-git-integration.html
2 changes: 1 addition & 1 deletion source/preparing/ide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Which one should I choose?

Every IDE has its pros and cons, and there is no single best IDE for Sponge development. The IDE you choose to use is
largely a matter of personal preference. That being said, it is worth mentioning that `IntelliJ IDEA Community Edition
<https://www.jetbrains.com/idea/download>`__ is fairly popular amongst a majority of the core Sponge team.
<https://www.jetbrains.com/idea/download/>`__ is fairly popular amongst a majority of the core Sponge team.

Downloads
=========
Expand Down
2 changes: 1 addition & 1 deletion source/preparing/text.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Installing a Text Editor
========================

Articles on SpongeDocs are saved as text files in the `reStructuredText <http://sphinx-doc.org/rest.html>`_ markup
Articles on SpongeDocs are saved as text files in the `reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_ markup
language. Although your operating system's default text editor is likely sufficient for editing these files, installing
a different text editor may prove to be useful.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Here is the default server.properties file of an unmodified Minecraft 1.8.1 serv
Property Explanation
----------------------

Credit goes to the editors at the `Minecraft Wiki <http://minecraft.gamepedia.com>`__ for the explanations.
Credit goes to the editors at the `Minecraft Wiki <https://minecraft.gamepedia.com>`__ for the explanations.

**Boolean** properties have only two valid values: *true* and *false*.
**Integer** properties must be whole numbers. Where a range is specified, the number must be in that range.
Expand Down Expand Up @@ -134,9 +134,9 @@ Credit goes to the editors at the `Minecraft Wiki <http://minecraft.gamepedia.co
| | | | false. |
+-------------------------------+-------------+-------------+------------------------------------------------------------+
| generator-settings | string | *blank* | The settings used to customize world generation. See |
| | | | `Superflat <http://minecraft.gamepedia.com/Superflat>`__ |
| | | | `Superflat <https://minecraft.gamepedia.com/Superflat>`__ |
| | | | and |
| | | | `Customized <http://minecraft.gamepedia.com/Customized>`__ |
| | | | `Customized <https://minecraft.gamepedia.com/Customized>`__|
| | | | on the Minecraft Wiki (external links) for possible |
| | | | settings and examples. |
+-------------------------------+-------------+-------------+------------------------------------------------------------+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ This config was generated using SpongeForge build 2360 (with Forge 2282), Sponge
# # If you need help with the configuration or have any questions related to Sponge,
# # join us at the IRC or drop by our forums and leave a post.
#
# # IRC: #sponge @ irc.esper.net ( http://webchat.esper.net/?channel=sponge )
# # IRC: #sponge @ irc.esper.net ( https://webchat.esper.net/?channel=sponge )
# # Forums: https://forums.spongepowered.org/
#

Expand Down
Loading