-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
saner docs site versions #2545
saner docs site versions #2545
Conversation
- docs/ => site/ for deploying to gh-pages - refactor copy tasks for legibility
(for the wiki page) Bonus: Releasing a previous major versionThe main branch of this repository contains latest code. Making a 1.x or 2.x release is similar to the process above (target
|
fix gitignore to actually track docs/site/versionsPreview: documentation | landing | table |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the new structure except two points:
- I feel like the git clean can be a foot cannon unless you know what you're doing. This is mitigated by the fact that this is only relevant on major releases.
- Releasing a new major version of docs requires a bit of careful thought and domain knowledge. This is mitigated by the release guide on the wiki
🌐 new site layout:
🔨 new deploy process:
site/
directory replacesdocs-static
as the only static site directory: no more git dir and a separate build dir.site/
contains the older versions (tracked in git) andyarn site
(🔨 new build task) will copy the landing and docs apps into their proper places insite/
so it is ready toyarn deploy
.you can see updated links in versions menu (but they don't work on circle).
i'm going to make related PRs on 1.x and 2.x to simplify theversions/
release processactually, PRs are not necessary! just need to update the wiki page: https://github.com/palantir/blueprint/wiki/Release-process