Discrepancy in documentation for Authentication sometimes root used as plone sometimes Plone
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 109
- Forks
- 107
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 4
Description
In http://plonerestapi.readthedocs.io/en/latest/authentication.html
the first example is using Plone as root for Get request
and on the same page the example of authentication with token plone is used as root for Get request
since it is mentioned here http://plonerestapi.readthedocs.io/en/latest/conventions.html#upper-vs-lowercase that we should use lowecase in URIs the first one should be changed to from Plone to plone
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open authentication.html and compare the first GET example with the token-authentication example. Check conventions.html for the lowercase URI rule, then change the inconsistent root in the first example and verify both examples use the same casing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100