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

Provide a wiki how to update the new manual #18

Closed
iloveeclipse opened this issue Jul 1, 2017 · 3 comments · Fixed by #22
Closed

Provide a wiki how to update the new manual #18

iloveeclipse opened this issue Jul 1, 2017 · 3 comments · Fixed by #22
Assignees

Comments

@iloveeclipse
Copy link
Member

I'm trying to understand how the current code here maps to the state I see at http://spotbugs.readthedocs.io/en/latest/.
I honestly have no clue.

We should provide a simple how to about fixing and uploading the docs.

@KengoTODA
Copy link
Member

Its code exists in docs directory in spotbugs project.
How to build is described in docs/README.md.

About .rst format, please refer official document.

Are they helpful enough for you?

@iloveeclipse
Copy link
Member Author

A-ha. It means, all the manual.xml ect files in the root of the https://github.com/spotbugs/spotbugs.github.io repo are obsoleted?
We should remove all of them.

After reading https://github.com/spotbugs/spotbugs/blob/master/docs/README.md I still have no clue how the result is deployed to https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html and what is needed for that.

I would prefer we would have a README.md in the root of this repository and explain all the needed points here or at least link to the another readme.

@KengoTODA
Copy link
Member

we would have a README.md in the root of this repository

OK I will propose PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants