-
Notifications
You must be signed in to change notification settings - Fork 188
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
[DO NOT MERGE] Prototype: archived versions, the main
end
#2128
Conversation
docusaurus.config.js
Outdated
{ | ||
label: "1.3", | ||
href: "https://1_3.docs.camunda.io", | ||
}, |
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.
We will introduce these one at a time, as each version is archived.
@@ -113,7 +113,7 @@ RewriteRule ^docs/apis-clients(.*)$ /docs/apis-tools$1 [R=301,L] | |||
RewriteRule ^optimize/apis-clients(.*)$ /optimize/apis-tools$1 [R=301,L] | |||
RewriteRule ^docs/8.0/apis-clients(.*)$ /docs/8.0/apis-tools$1 [R=301,L] | |||
RewriteRule ^optimize/3.8.0/apis-clients(.*)$ /optimize/3.8.0/apis-tools$1 [R=301,L] | |||
RewriteRule ^docs/1.3/apis-clients(.*)$ /docs/1.3/apis-tools$1 [R=301,L] | |||
# RewriteRule ^docs/1.3/apis-clients(.*)$ /docs/1.3/apis-tools$1 [R=301,L] |
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.
We'll let the 1.3 website handle any of these page-specific redirects...
static/.htaccess
Outdated
## extract version 1.3/optimize 3.7.0: | ||
# RewriteRule ^docs/1.3/(.*)$ https://1_3.docs.camunda.io/docs/$1 [R=301,L] |
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.
...and just send all 1.3 traffic over to that new site.
@@ -1 +1 @@ | |||
["3.10.0", "3.9.0", "3.8.0", "3.7.0"] |
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.
Associated with this change would be the removal of all optimize 3.7.0 docs from this branch.
@@ -1 +1 @@ | |||
["8.2", "8.1", "8.0", "1.3", "1.2", "1.1", "1.0", "0.26", "0.25"] |
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.
Associated with this change would be the removal of all archived docs from this branch.
We are 100% aligned here.
Do you need any additional help or feedback from me? |
docusaurus.config.js
Outdated
{ | ||
type: "html", | ||
className: "dropdown-archived-versions", | ||
value: "<b>Archived versions</b>", |
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.
Internally, I've asked PM for feedback on what to call this. I'll also follow up in the C8 Stakeholder meeting.
// ([versionName]) => ({ | ||
{ | ||
label: "1.3", | ||
href: "https://unsupported.docs.camunda.io/1.3/", |
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.
These URLs have been updated recently -- we'll put all archived versions in the same subdomain, but each one will have its own path on that server.
# RewriteRule ^docs/1.3/self-managed/optimize-deployment/(.*)$ /optimize/3.7.0/self-managed/optimize-deployment/$1 [R=301,L] | ||
|
||
## extract version 1.3/optimize 3.7.0: | ||
RewriteRule ^docs/1.3/(.*)$ https://unsupported.docs.camunda.io/1.3/docs/$1 [R=301,L] |
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.
This is the rule that sends all 1.3 traffic over to that archived site.
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.
Very clean and nice!
What is the purpose of the change
Demonstrates the "active docs" end of #1173. See #2129 for the "archived version" end.
This PR won't be merged, but it serves to provide actual code for a review of the approach & details.
What's happening on the "active docs" end?
Archived versions are not built in this site. In the real implementation, we could remove the source for all archived versions.
Rewrite rules are updated to send all 1.3 requests to the archived 1.3 website.
A link is added to the navbar for each archived version:
Clarifying comments will also be added in-line.
A video demonstrating the relationship between this and the active docs
An updated recording is at https://www.loom.com/share/e8d5c9d736554f71b66bbcf774de09e0