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

Rethink website publishing so that website describes stable release, not unreleased changes on master #1228

Closed
cspotcode opened this issue Feb 17, 2021 · 0 comments · Fixed by #1297
Milestone

Comments

@cspotcode
Copy link
Collaborator

Not sure the best way to do this. The website should describe the stable release on npm, not unreleased changes on master.


2x goals:

  • a) We want to be able to fix, improve the website docs and re-publish without an npm release
  • b) But we also want to be able to update docs alongside a new feature implementation, and merge that feature to master without breaking the website.

One solution is to forget about doing a)

The other is to keep either 2x directories or 2x branches of docs:

  • one to describe stable npm release
  • the other to describe new features

Doing this with branches is probably the easiest. Merge master -> docs branch, then run the docusaurus build on the docs branch. Docs updates can be made as PRs directly against the docs branch, not master.

However, that might not play nice with the docusaurus "Edit" button? Do we care?

@cspotcode cspotcode added this to the 10.0.0 milestone Apr 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant