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

[Docs] Move API docs into the API module #6151

Merged
merged 1 commit into from
Mar 10, 2020
Merged

Conversation

driusan
Copy link
Collaborator

@driusan driusan commented Mar 9, 2020

This moves the documentation for the REST API into the
API module. It existed under docs previously because
it was written before the module existed.

Symlinks are used to keep the documentation rendered
under ReadTheDocs since it's useful to include a reference
for users looking to use the LORIS API.

If we're lucky, I didn't break anything.

This moves the documentation for the REST API into the
API module. It existed under docs previously because
it was written before the module existed.

Symlinks are used to keep the documentation rendered
under ReadTheDocs since it's useful to include a reference
for people reading the LORIS documentation.
@driusan driusan added Cleanup PR or issue introducing/requiring at least one clean-up operation Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) Meta PR does something that organizes, upgrades, or manages the functionality of the codebase labels Mar 9, 2020
@johnsaigle
Copy link
Contributor

  1. MriViolationsTestIntegrationTest::testNotResolvedSaveButton

Transitory failure? We should look out for this during testing and maybe disable this test if it's not working

Copy link
Contributor

@johnsaigle johnsaigle left a comment

Choose a reason for hiding this comment

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

Looks fine. I'm in favour of merging it. We can see whether ReadTheDocs will do symlinks and fix if not

@driusan
Copy link
Collaborator Author

driusan commented Mar 10, 2020

It should definitely work with the symlinks. The question is if it would work without them..

@driusan driusan merged commit 2db086f into aces:master Mar 10, 2020
@ridz1208 ridz1208 added this to the 24.0.0 milestone Apr 1, 2020
maltheism pushed a commit to maltheism/Loris that referenced this pull request Apr 7, 2020
This moves the documentation for the REST API into the
API module. It existed under docs previously because
it was written before the module existed.

Symlinks are used to keep the documentation rendered
under ReadTheDocs since it's useful to include a reference
for people reading the LORIS documentation.
laemtl pushed a commit to laemtl/Loris that referenced this pull request Jun 10, 2020
This moves the documentation for the REST API into the
API module. It existed under docs previously because
it was written before the module existed.

Symlinks are used to keep the documentation rendered
under ReadTheDocs since it's useful to include a reference
for people reading the LORIS documentation.
laemtl pushed a commit to laemtl/Loris that referenced this pull request Jun 16, 2020
This moves the documentation for the REST API into the
API module. It existed under docs previously because
it was written before the module existed.

Symlinks are used to keep the documentation rendered
under ReadTheDocs since it's useful to include a reference
for people reading the LORIS documentation.
@christinerogers
Copy link
Contributor

followup note - the wiki main link broke. samir emailed me for an urgent fix on this today.

AlexandraLivadas pushed a commit to AlexandraLivadas/Loris that referenced this pull request Jun 29, 2021
This moves the documentation for the REST API into the
API module. It existed under docs previously because
it was written before the module existed.

Symlinks are used to keep the documentation rendered
under ReadTheDocs since it's useful to include a reference
for people reading the LORIS documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) Cleanup PR or issue introducing/requiring at least one clean-up operation Meta PR does something that organizes, upgrades, or manages the functionality of the codebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants