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: Generate API documentation for release branch #9081

Merged
merged 1 commit into from
Apr 13, 2024

Conversation

dplewis
Copy link
Member

@dplewis dplewis commented Apr 12, 2024

Pull Request

Issue

Master branch has been removed in favor of a release branch. Currently there is no permanent link to the documentation for the latest api. There are release version specific links but those can get stale as new releases are publish.

Approach

Adds support for links that match the latest release. Fixes broken image link in documentation.

Before:
https://parseplatform.org/parse-server/api/master/ParseServerOptions.html

After:
https://parseplatform.org/parse-server/api/release/ParseServerOptions.html

Tasks

  • Add tests
  • Add changes to documentation (guides, repository pages, code comments)
  • Add security check
  • Add new Parse Error codes to Parse JS SDK

Copy link

Thanks for opening this pull request!

  • ❌ Please link an issue that describes the reason for this pull request, otherwise your pull request will be closed. Make sure to write it as Closes: #123 in the PR description, so I can recognize it.

@dplewis dplewis requested a review from a team April 12, 2024 22:09
@mtrezza
Copy link
Member

mtrezza commented Apr 13, 2024

We do not seem to have a docs dry-run? That would help to review change like this.

@dplewis
Copy link
Member Author

dplewis commented Apr 13, 2024

You can just copy release_docs.sh and run the following to see the output. This change is nearly identical to the JS SDK

$ GITHUB_ACTIONS=true SOURCE_TAG=test ./release_docs.sh

@mtrezza mtrezza merged commit bceb621 into parse-community:alpha Apr 13, 2024
19 of 24 checks passed
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 7.1.0-alpha.6

@parseplatformorg parseplatformorg added the state:released-alpha Released as alpha version label Apr 14, 2024
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 7.1.0-beta.1

@parseplatformorg parseplatformorg added the state:released-beta Released as beta version label Jun 30, 2024
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 7.1.0

@parseplatformorg parseplatformorg added the state:released Released as stable version label Jun 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state:released Released as stable version state:released-alpha Released as alpha version state:released-beta Released as beta version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants