parse-server icon indicating copy to clipboard operation
parse-server copied to clipboard

Parse Server Docs have not been generated since 5.2.0

Open dblythy opened this issue 3 years ago • 3 comments
trafficstars

New Issue Checklist

Issue Description

The Parse Server Docs do not support the alpha branch. It only has the master branch which has not been updated in 6 months.

Steps to reproduce

https://github.com/parse-community/parse-server/tree/gh-pages/api

Actual Outcome

Should have updated alpha branch

Expected Outcome

Environment

Server

  • Parse Server version: alpha
  • Operating system: macos
  • Local or remote host (AWS, Azure, Google Cloud, Heroku, Digital Ocean, etc): -

Database

  • System (MongoDB or Postgres): mongoDb
  • Database version: n/a
  • Local or remote host (MongoDB Atlas, mLab, AWS, Azure, Google Cloud, etc): localhost

Client

  • SDK (iOS, Android, JavaScript, PHP, Unity, etc): -
  • SDK version: -

Logs

dblythy avatar Sep 14 '22 05:09 dblythy

Thanks for opening this issue!

  • 🚀 You can help us to fix this issue faster by opening a pull request with a failing test. See our Contribution Guide for how to make a pull request, or read our New Contributor's Guide if this is your first time contributing.

I think since these are the official docs, we'd only want the release branch to be documented. Unless we can find a way to publish docs for each branch separately. The generated docs have a API part in their path.

mtrezza avatar Sep 14 '22 07:09 mtrezza

The reason there haven't been any updates since 5.2.0 is because I think since then we only released security hot fixes which are merged in a way that doesn't create docs. It also doesn't create a docker release but that is done manually after merging. Maybe a workaround is to add a CI job that also allows to manually generate docs.

mtrezza avatar Sep 14 '22 07:09 mtrezza