-
-
Notifications
You must be signed in to change notification settings - Fork 39
feat(docs): fetch docs from monorepository branches #103
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
Conversation
ce98472
to
b34c431
Compare
b34c431
to
6f85107
Compare
Couple of questions:
|
Not sure how yet, but should be feasible yeah!
That's one step added but I think it's beneficial in the long run. We could add that to a post update hook too
Yeah good point actually... besides using the usual workflow after a pull and copy-pasting back to the main repo, I don't see a good solution here
I explained it bad: it's in each version's branch inside a |
Could we make it so that we symlink the docs folder locally? Maybe even with a command. Something like
I figured, but wanted to be sure. Perfect |
That's a really good idea. I implemented that, let me know! |
a86e809
to
2d196d6
Compare
This pull request updates how the versioning of docs works.
Instead of having a
content
directory with all copies of all versions, we have adocs:pull
command that fetches documentation fromtempestphp/tempest-framework:docs
. Thedocs
directory of the monorepository should contain all the documentation.During local development, we can do
tempest docs:pull
ortempest docs:pull 1.x
for a specific version. During deployment, we need to dotempest docs:pull
as well before static page generation.This is mainly for improving the experience or editing docs when we support multiple versions, because it's easy to edit a file for a different version by mistake. To go ahead with this, we need to first migrate the current docs to a
docs
directory on themain
and2.x
branchesThis PR also updates the docs URLs to be immutable. We had this conversation already, but here is a summary:
/docs
redirects to the current version, right now it's/1.x
)noindex
meta and a canonical URL to the current version (eg. if the current version is 2.x, a/1.x/foo/bar
URL would get a canonical to/2.x/foo/bar
)/docs
one