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

URL handling for different versions of the docs #5794

Closed
niklas-wortmann opened this issue Oct 4, 2020 · 2 comments
Closed

URL handling for different versions of the docs #5794

niklas-wortmann opened this issue Oct 4, 2020 · 2 comments
Labels
docs Issues and PRs related to documentation

Comments

@niklas-wortmann
Copy link
Member

From my point of view we need the following "environments":
next => currently master, specific docs for next major version
stable => currently in the 6.x branch (this should always point to https://rxjs.dev)
all past versions => soo this will be the 6.x

We basically have two different options how to structure the urls. We can use either subdomains of rxjs.dev or we use subfolders.

Pro and cons:

subdomains (v6.rxjs.dev:

  • toolchain already in place from angular.io (low effort)
  • allows changes to older versions (likely not happening though)
  • dedicated deployments
  • major release cause some effort to setup the docs properly
  • firebase needs a dns entry configuration

subfolder (rxjs.dev/v6):

  • easy deployment
  • html 5 routing might be a bit tricky as every subfolder is an own app
  • compiled artifacts of archived versions have to be checked in in github
  • toolchain needs to be changed (a little bit more effort in the beginning)

related to #5793 & #5792

@niklas-wortmann niklas-wortmann added AGENDA ITEM Flagged for discussion at core team meetings docs Issues and PRs related to documentation labels Oct 4, 2020
@niklas-wortmann niklas-wortmann mentioned this issue Oct 5, 2020
8 tasks
@benlesh
Copy link
Member

benlesh commented Oct 7, 2020

Core Team Meeting: Generally okay with the path-of-least-resistance and using the sub-domain.

@benlesh benlesh removed the AGENDA ITEM Flagged for discussion at core team meetings label Oct 7, 2020
@cartant
Copy link
Collaborator

cartant commented Apr 30, 2021

Closing this 'cause, AFAICT, the v6 subdomain is now a thing.

@cartant cartant closed this as completed Apr 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

3 participants