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

[API-8] Docs Update Tracker #855

Open
ST-DDT opened this issue Nov 27, 2020 · 2 comments
Open

[API-8] Docs Update Tracker #855

ST-DDT opened this issue Nov 27, 2020 · 2 comments
Assignees
Labels
help wanted We would appreciate contributions high priority This needs to be fixed ASAP input wanted We would like to hear your opinion outdated docs The API has changed and the docs are outdated todo A reminder to do things
Milestone

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Nov 27, 2020

We plan to update the existing API 7 docs to API 8.
This is a complete tree of the existing docs, all unchecked pages needs to be checked whether they need to be updated and be updated or replaced.
Feel free to add a comment regarding API features that have been added and are not documented at all yet.
If you wish to be in charge of the update for a particular page or section, please comment. We appreciate any help.
All PRs regarding the api-8 docs should target the https://github.com/SpongePowered/SpongeDocs/tree/api-8 branch.

  • index.rst
  • about
    • assets.rst
    • faq.rst
    • future.rst
    • glossary.rst
    • history.rst
    • index.rst
    • introduction.rst
    • license.rst
    • posting.rst
    • privacy.rst
    • rules.rst
    • staff.rst
    • structure.rst
    • tos.rst
  • contributing
  • ore
    • api.rst
    • guidelines.rst
    • index.rst
    • publish.rst
    • routes
      • deploy-version.rst
      • download.rst
      • list-projects.rst
      • list-users.rst
      • list-versions.rst
      • project-version.rst
      • project.rst
      • user.rst
    • security.rst
  • plugin
    • api-versions.rst
    • assets.rst ⚠️
    • bans.rst
    • blocks
      • accessing.rst
      • concepts.rst
      • index.rst
      • modifying.rst
      • tileentities.rst
      • virtualblock.rst
    • bookview.rst ⚠️
    • buildsystem.rst
    • commands
      • arguments.rst
      • childcommands.rst
      • commandcallable.rst
      • creating.rst
      • flags.rst ⚠️
      • index.rst
    • configuration ⚠️
      • index.rst ⚠️
      • loaders.rst ⚠️
      • nodes.rst ⚠️
      • serialization.rst ⚠️
    • data
      • customdatamanipulators.rst
      • index.rst
      • keys.rst
      • serialization.rst
      • transactions.rst
    • database.rst ⚠️
    • debugging.rst
    • economy
      • basics.rst
      • implementing.rst
      • index.rst
      • practices.rst
      • using.rst
    • effects.rst ⚠️
    • entities
      • ai.rst ⚠️
      • custom-ai.rst ⚠️
      • index.rst
      • modifying.rst ⚠️
      • spawning.rst
    • event
      • causes.rst
      • custom.rst
      • filters.rst
      • index.rst
      • listeners.rst
    • game-profile-manager.rst ⚠️
    • index.rst
    • injection.rst ⚠️
    • internals
      • access-transformers.rst
      • implementation.rst
      • index.rst
      • mcp-setup.rst
      • mcp.rst
      • mixins.rst
    • items
      • creating.rst ⚠️
      • index.rst
      • usage.rst ⚠️
    • lifecycle.rst
    • logging.rst
    • manager.rst
    • metrics.rst ⚠️
    • offline-userplayer-data.rst
    • optional
      • basic.rst
      • index.rst
      • usage.rst
    • permissions.rst ⚠️
    • placeholders
      • creatingtokens.rst ⚠️
      • index.rst ⚠️
      • retrievingtext.rst ⚠️
    • plugin-class.rst
    • plugin-identifier.rst
    • plugin-meta.rst
    • practices
      • bad.rst
      • best.rst
      • index.rst
    • project
      • gradle.rst
      • index.rst
      • maven.rst
      • version-numbers.rst
    • ray-tracing.rst ⚠️
    • scheduler.rst ⚠️
    • services.rst
    • tab-lists.rst ⚠️
    • text
      • index.rst
      • messagechannels.rst 👻
      • pagination.rst
      • representations
        • configurate.rst 👻
        • formatting-code-legacy.rst 👻
        • plain 👻
        • index.rst
        • json.rst 👻
      • templates.rst 👻
      • text.rst
    • trade-offers.rst ⚠️
    • tutorials.rst
    • wgen
      • customwgen.rst ⚠️
      • index.rst ⚠️
      • modifiers.rst ⚠️
    • workspace
      • eclipse.rst
      • idea.rst
      • index.rst
  • preparing
    • git.rst
    • ide.rst
    • index.rst
    • jdk.rst
    • text.rst
  • server
    • getting-started
      • bungeecord.rst
      • configuration
        • hocon.rst
        • index.rst
        • sponge-conf.rst
      • implementations
        • index.rst
        • spongeforge.rst
        • spongevanilla.rst
      • index.rst
      • jre.rst
      • launch-script.rst
      • migrating.rst
      • port-forward.rst
    • index.rst
    • management
      • bans.rst
      • exploit-patches.rst
      • index.rst
      • performance-tweaks.rst
      • permissions.rst
      • plugins.rst
      • whitelist.rst
    • quickstart.rst
    • spongineer
      • bugreport.rst
      • commands.rst
      • debugging.rst
      • incompatible.rst
      • index.rst
      • logs.rst
      • properties.rst
      • troubleshooting.rst
  • versions
    • filenames.rst
    • index.rst
    • legacy-versions.rst
    • versioning.rst

⚠️ = Broken imports/class/method references
🔥 = Might need a rewrite
👻 = This page is empty/awaiting content

Update-Tasks:

  1. Check all pages
  2. Fix imports/class/method references (Initial scan completed)
  3. Fix code examples
  4. Rewrite broken pages
  5. Check the docs for errors
  6. Goto 4
@ST-DDT ST-DDT added help wanted We would appreciate contributions input wanted We would like to hear your opinion high priority This needs to be fixed ASAP outdated docs The API has changed and the docs are outdated todo A reminder to do things labels Nov 27, 2020
@ST-DDT ST-DDT added this to the v8.0.0 milestone Nov 27, 2020
@ST-DDT ST-DDT self-assigned this Nov 27, 2020
@ST-DDT ST-DDT changed the title [API-8] Ignore unsalvagable pages for api update [API-8] Collect/ignore unsalvagable pages for api update Nov 27, 2020
@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 27, 2020

@ST-DDT ST-DDT changed the title [API-8] Collect/ignore unsalvagable pages for api update [API-8] Docs Update Tracker Nov 29, 2020
@mosemister
Copy link
Member

plugin-class.rst im not seeing any broken imports nor class/method references. Could someone expand on whats wrong with it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We would appreciate contributions high priority This needs to be fixed ASAP input wanted We would like to hear your opinion outdated docs The API has changed and the docs are outdated todo A reminder to do things
Projects
None yet
Development

No branches or pull requests

2 participants