GithubHelp home page GithubHelp logo

Rename 'latest' to 'dev' about st2docs HOT 3 OPEN

stackstorm avatar stackstorm commented on June 12, 2024 1
Rename 'latest' to 'dev'

from st2docs.

Comments (3)

LindsayHill avatar LindsayHill commented on June 12, 2024

Probably OK. Just as long as we catch the various places that need updating.

Shouldn't screw up Google ranking for docs, now that we've been using canonical_url for a while, and most Google search results are looking good now.

from st2docs.

blag avatar blag commented on June 12, 2024

One way to have documentation across multiple versions is the Django documentation.

Browsing to docs.djangoproject.com redirects you to the current latest stable docs (which is 2.1 as of this comment):

https://docs.djangoproject.com -> https://docs.djangoproject.com/en/2.1

Every major release has its own dedicated documentation:

  • http://docs.djangoproject.com/en/1.8
  • http://docs.djangoproject.com/en/1.9
  • http://docs.djangoproject.com/en/2.0
  • http://docs.djangoproject.com/en/2.1

The documentation for the version in development is at dev, and it contains a big yellow warning banner at the top:

https://docs.djangoproject.com/en/dev/

And they have nifty language and version pickers that float on every page.

If we adopt a similar structure, the latest documentation can use canonical URLs to point back to the documentation for the current stable version.

from st2docs.

LindsayHill avatar LindsayHill commented on June 12, 2024

We already have most of those pieces, the only difference is that we also have a copy of docs at/, rather than redirecting from there to /x.y

Happy to look at PR, but right now I don't feel like figuring out what changes are needed in the various release machinery + version picker + warning banners that we have.

from st2docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.