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

Publish API docs for pre-releases #8685

Open
3 tasks done
mtrezza opened this issue Jul 7, 2023 · 1 comment
Open
3 tasks done

Publish API docs for pre-releases #8685

mtrezza opened this issue Jul 7, 2023 · 1 comment
Labels
bounty:$20 Bounty applies for fixing this issue (Parse Bounty Program) type:docs Only change in the docs or README

Comments

@mtrezza
Copy link
Member

mtrezza commented Jul 7, 2023

New Feature / Enhancement Checklist

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

@parse-github-assistant
Copy link

Thanks for opening this issue!

  • 🎉 We are excited about your ideas for improvement!

@mtrezza mtrezza added type:docs Only change in the docs or README bounty:$20 Bounty applies for fixing this issue (Parse Bounty Program) labels Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty:$20 Bounty applies for fixing this issue (Parse Bounty Program) type:docs Only change in the docs or README
Projects
None yet
Development

No branches or pull requests

1 participant