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

change manual location and add unstable version #505

Merged
merged 11 commits into from Aug 28, 2020
Merged

Conversation

garbas
Copy link
Member

@garbas garbas commented Aug 21, 2020

fixes #237


This change is Reviewable

* add redirects from old urls
* old manuals are now served as stable
* and unstable manuals were added
* <link rel="cannonical" url=".." /> was added not to confuse search
  engines
@garbas garbas requested a review from edolstra August 21, 2020 21:51
@garbas garbas changed the title change manual location change manual location and add unstable version Aug 21, 2020
@github-actions
Copy link
Contributor

@samueldr
Copy link
Member

I guess the selector is WIP and unfinished?

image

Or is it a bug?

fix-manual-headers.sh Outdated Show resolved Hide resolved
fix-manual-headers.sh Outdated Show resolved Hide resolved
fix-manual-headers.sh Show resolved Hide resolved
@davidak
Copy link
Member

davidak commented Aug 22, 2020

The requested content at /manual/nixos/unstable could not be found.

https://nixos.org/manual/nixos/unstable

@samueldr
Copy link
Member

The requested content at /manual/nixos/unstable could not be found.

https://nixos.org/manual/nixos/unstable

See the "Drop the protocol and domain name from href" comment that explains why this happens. Basically the switcher links always point to the nixos.org domain even when served on another domain. (Assuming you got this using the switcher.)

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@garbas
Copy link
Member Author

garbas commented Aug 24, 2020

I guess the selector is WIP and unfinished?

image

Or is it a bug?

It looks like style is not applied. /me checks

@github-actions
Copy link
Contributor

@edolstra
Copy link
Member

In addition to /manual/nixos/stable, maybe we should also have /manual/nixos/20.03 etc. like the Postgres manuals, which have https://www.postgresql.org/docs/12/index.html and https://www.postgresql.org/docs/current/index.html.

@github-actions
Copy link
Contributor

@garbas
Copy link
Member Author

garbas commented Aug 24, 2020

@edolstra

In addition to /manual/nixos/stable, maybe we should also have /manual/nixos/20.03 etc. like the Postgres manuals, which have https://www.postgresql.org/docs/12/index.html and https://www.postgresql.org/docs/current/index.html.

Should we redirect /manual/nixos/20.09 to /manual/nixos/unstable or /manual/nixos/unstable to /manual/nixos/20.09 (I assume the second option)?

I think postgresql.org could do a much better job at documentation. A simple search for "postgresql psql" returns result that points to 9.3 version which is unsuported. Also their current version does not redirect to 12 - in the url - but rather uses separate url. They also don't use any header tab to point to canonical version of documentation.

I propose the following:

  • for both channels (stable / unstable) I would create a redirect to latest minor version, eg: /manual/nix/stable -> /manual/nix/1.3
  • to the version/channel switcher box I would list both Channels (stable/unstable) and Versions (19.09/20.03/20.09/...)
  • wherever we are pointing to documentation we should be pointing to "stable" channel
  • the canonical tag will be still pointing to "stable" channel

Sound ok?

Also should we might start keeping older versions of documentation around (like postgresql)?

@github-actions
Copy link
Contributor

@garbas
Copy link
Member Author

garbas commented Aug 28, 2020

Another question that raised in my head since few days: Are we going to always keep documentation online, especially the versioned one?

What will happen is that with every release we will break what google has indexed. eg. All documentation under /manual/nixos/20.03 will be removed once 20.09 is released.

For sake of moving forward with this I would suggest we only introduce channels (stable/unstable).
It would be extremely nice to have all of the versions of documentation always there, but we might need to have another discussion regarding this especially once all the work around documentation format and tooling is decided.

/cc @edolstra

@github-actions
Copy link
Contributor

@garbas garbas merged commit 04a36f3 into master Aug 28, 2020
@garbas garbas deleted the manual-structure branch August 28, 2020 09:39
@davidak
Copy link
Member

davidak commented Aug 28, 2020

For sake of moving forward with this I would suggest we only introduce channels (stable/unstable).
It would be extremely nice to have all of the versions of documentation always there, but we might need to have another discussion regarding this especially once all the work around documentation format and tooling is decided.

yes, we keep all the packages, so why would we not keep the manual. having stable and unstable is already a huge step 🎉

@samueldr samueldr mentioned this pull request Aug 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Keep versioned manuals
4 participants