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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>
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>
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>
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Reviewers: You can build the documentation locally with |
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Alternatively, here is a zip file containing the generated HTML files: transformer-html.zip |
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
bmaher
approved these changes
Mar 5, 2019
Signed-off-by: Thibaut Le Page <thibaut.le.page@zalando.de>
This was referenced Mar 5, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs/
directory at the root of Transformer's repository.make doc
to build the documentation locally.README.md
,CHANGELOG.md
,CONTRIBUTING.md
, andCONTRIBUTORS.md
to the reST format for homogeneity and inclusion in the Sphinx-generated documentation.Part of #28.
Types of Changes
What types of changes does your code introduce? Keep the ones that apply:
Tasks
List of tasks you will do to complete the PR:
docs/
.Deployment Notes
Once this PR is merged:
README.rst
, replace the documentation link (currently pointing to the wiki) accordingly,