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

[core] Add release step for the docs #890

Merged

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Sep 3, 2022

  • As far as I know, we can't have https://mui.com/toolpad to map with https://github.com/mui/mui-toolpad/commits/master. This would lead to one structural problem: Documenting new features that developers can't use because not been released yet. There are also other considerations like making it harder to batch the release of PRs together, but it's probably secondary. I have changed the configuration in Netlify and now intend to document it.
  • Github -> GitHub

As side note, I think that it would be better to move the release step to a different markdown than the contributing guide, the community doesn't care about how we release, at best, it's noise for them and worse, we overwhelm/confuse them. I would recommend the same pattern as https://github.com/mui/mui-x/blob/master/scripts/README.md.

@oliviertassinari oliviertassinari added the core Infrastructure work going on behind the scenes label Sep 3, 2022
@Janpot
Copy link
Member

Janpot commented Sep 5, 2022

Documenting new features that developers can't use because not been released yet.

I believe over time we could aim at versioning our docs as well. One version per toolpad version. By default the user is directed to the last released version. There would be a "next" version or something that contains whatever is on the master branch.

I think that it would be better to move the release step to a different markdown than the contributing guide

I'm fine with making that part of this PR. Otherwise will do after this gets merged.

@apedroferreira
Copy link
Member

apedroferreira commented Sep 5, 2022

+1 for separating the release instructions

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Sep 10, 2022

Ok, so it seems that this workflow proposal is accepted, I'm merging.

For moving the maintainers content out of the contributing guide, I'm not doing it here, it's a different problem.

@oliviertassinari oliviertassinari merged commit 4dc8b92 into mui:master Sep 10, 2022
@oliviertassinari oliviertassinari deleted the add-a-step-for-the-docs branch September 10, 2022 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants