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.

Sign up for GitHub

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

Jump to bottom

Add tools for maintaining the docs #754

Merged
merged 8 commits into from Nov 16, 2018
Merged

Add tools for maintaining the docs #754

merged 8 commits into from Nov 16, 2018

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Aug 26, 2018 •
edited

Currently everyone maintains a private copy of tools that he/she needs for maintenance tasks.

This is bad in multiple ways:

  • Everyone has to write it himself
  • Improvements don't get shared
  • Team-members tend to change from time to time
  • It cannot be used in automation

Thats why I started this attempt to publish the required sources in the repo as well.

Existing tools

@narikiro It would be nice if you could upload your sources for the Definition List Generator somewhere/here (once the remaining questions have been resolved)

Remaining questions

@SpongePowered/docs

  • Store it in the Docs repo itself or in a separate repo/repo per tool?
    • In the repo
  • Which coding conventions should be used?
    • Sponge's but less strict
  • Restrictions on used applications such as jdk or build tools?
    • None
  • Which license should be used?
    • Any free license, preferable MIT or unlicense
  • Did I forget something?

@ST-DDT ST-DDT added meta Issues/Discussions about the docs backend question There is a question here that needs an answer input wanted We would like to hear your opinion needs review The submission is ready and needs to be reviewed labels Aug 26, 2018
@Spongy
Copy link

Spongy commented Aug 26, 2018 •
edited

A preview for this pull request is available at https://cdn.rawgit.com/Spongy/SpongeDocs-PRs/9f1778c/.

Here are some links to the pages that were modified:

Since the preview frequently changes, please link to this comment, not to the direct url to the preview.

@ST-DDT ST-DDT mentioned this pull request Aug 26, 2018
Closed
Inscrutable
Inscrutable reviewed Aug 29, 2018
View reviewed changes
Copy link
Member

@Inscrutable Inscrutable left a comment

Choose a reason for hiding this comment

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

Now we have the sharpest tools on the block. 🛠 Someone still needs to review the code content.

tools/javadoc-checker/README.md Outdated Show resolved Hide resolved
tools/javadoc-checker/README.md Outdated Show resolved Hide resolved
@Inscrutable
Copy link
Member

I am inclined to keep the tools under the docs repository unless that causes technical difficulties. We don't want to scatter stuff too widely. Licensing is up to authors, but we'd prefer MIT if possible (or unlicense).

@Inscrutable Inscrutable mentioned this pull request Aug 29, 2018
Closed
ST-DDT
ST-DDT commented Aug 30, 2018
View reviewed changes
tools/javadoc-checker/pom.xml Outdated Show resolved Hide resolved
tools/javadoc-checker/src/main/resources/log4j2.xml Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Member Author

ST-DDT commented Aug 31, 2018

Compile Code Checker @ 50%

@ST-DDT
Copy link
Member Author

ST-DDT commented Sep 1, 2018

Compile Code Checker @ 100%

@narikiro Do you want to append your tool/code here or do you want to push it in a separate PR?

@12awsomeman34
Copy link
Contributor

I will PR when I find the opportunity.

@ST-DDT
Copy link
Member Author

ST-DDT commented Sep 3, 2018

Then we only need a review for the actual code.
Do we need unit tests for those tools?

@ST-DDT
Copy link
Member Author

ST-DDT commented Sep 20, 2018

Updated for API 7.1

@Inscrutable Inscrutable removed input wanted We would like to hear your opinion question There is a question here that needs an answer labels Oct 5, 2018
@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 8, 2018

Updated to fix merge conflicts.
Some last change requests?

@ST-DDT ST-DDT merged commit 4037979 into stable Nov 16, 2018
@ST-DDT ST-DDT deleted the feature/add-doc-tools branch November 16, 2018 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Inscrutable Inscrutable Inscrutable left review comments

Assignees
No one assigned
Labels
meta Issues/Discussions about the docs backend needs review The submission is ready and needs to be reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@ST-DDT @Spongy @Inscrutable @12awsomeman34