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

Copy our wiki doc under docs/ for GitHub Pages #38

Merged
merged 13 commits into from Mar 5, 2019
Merged

Conversation

thilp
Copy link
Member

@thilp thilp commented Feb 27, 2019

  • Copy all documentation from the wiki in a docs/ directory at the root of Transformer's repository.
  • Add some static site generator there as well: I have chosen Sphinx.
  • Add make doc to build the documentation locally.
  • Migrate README.md, CHANGELOG.md, CONTRIBUTING.md, and CONTRIBUTORS.md to the reST format for homogeneity and inclusion in the Sphinx-generated documentation.
  • Add documentation about:
    • Transformer's release process;
    • how to contribute: conventions, maintaining the documentation;
    • Transformer's plugin system (with pictures!).
  • Add technical documentation (reST docstrings included in the Sphinx-generated HTML).

Part of #28.

Types of Changes

What types of changes does your code introduce? Keep the ones that apply:

  • Documentation / non-code

Tasks

List of tasks you will do to complete the PR:

  • Copy the wiki contents in docs/.
  • Add a static site generator. Check that it works locally with the copied documentation.

Deployment Notes

Once this PR is merged:

  • activate Read The Docs for this repository,
  • in README.rst, replace the documentation link (currently pointing to the wiki) accordingly,
  • deactivate the wiki tab.

Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
And add/link technical documentation to the user documentation, since
Sphinx makes it so easy.

Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
@zalando-incubator zalando-incubator deleted a comment Mar 3, 2019
Document project documentation and the release process.

Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
@zalando-incubator zalando-incubator deleted a comment Mar 4, 2019
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
@zalando-incubator zalando-incubator deleted a comment Mar 4, 2019
@zalando-incubator zalando-incubator deleted a comment Mar 4, 2019
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
@thilp thilp marked this pull request as ready for review March 5, 2019 09:14
@zalando-incubator zalando-incubator deleted a comment Mar 5, 2019
@thilp
Copy link
Member Author

thilp commented Mar 5, 2019

Reviewers: You can build the documentation locally with make doc (sphinx is installed by Poetry so I recommend a make configure first), then open it with firefox/chrome/whatever docs/_build/html/index.html.

Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
@zalando-incubator zalando-incubator deleted a comment Mar 5, 2019
@thilp
Copy link
Member Author

thilp commented Mar 5, 2019

Alternatively, here is a zip file containing the generated HTML files: transformer-html.zip

@zalando-incubator zalando-incubator deleted a comment Mar 5, 2019
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
@zalando-incubator zalando-incubator deleted a comment Mar 5, 2019
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
@zalando-incubator zalando-incubator deleted a comment Mar 5, 2019
@thilp thilp merged commit cf130f8 into master Mar 5, 2019
@thilp thilp deleted the fix-releasing branch March 5, 2019 12:11
This was referenced Mar 5, 2019
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 this pull request may close these issues.

None yet

2 participants