parse-community / parse-community/parse-server
Publish API docs for pre-releases
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 21.4k
- Forks
- 4.8k
- Avg merge
- 7h 45m
- Merged PRs (30d)
- 11
Description
New Feature / Enhancement Checklist
- I am not disclosing a vulnerability.
- I am not just asking a question.
- I have searched through existing issues.
Current Limitation
API docs are only published for stable releases, not for pre-releases. This makes it difficult for people to test out pre-releases.
Feature / Enhancement Description
Publish API docs also for pre-releases
The only issue may be that the default API URL:
http://parseplatform.org/parse-server/api/
points to the latest published release as defined in:
https://github.com/parse-community/parse-server/blob/gh-pages/api/index.html
If we publish a pre-release the default page would currently be the pre-release docs, which is incorrect and likely confusing since the API docs do not show the API version anywhere in the docs, only in the browser URL.
n/a
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
Inspect gh-pages/api/index.html and the existing process that publishes stable API docs. Determine how pre-release docs can be published without making the default API URL serve them; done means pre-release docs are accessible while the default URL still points to the latest stable release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, nodejs
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100