Comments (3)
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.
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.
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)
- Add information on setting api key in cli config file
- HA doc needs an update RE: list of services relying on [coordination] backend HOT 1
- LDAP update following the st2 core integration from Enterprise
- RBAC doc update after feature transition enterprise -> st2 OSS core
- StackStorm Exchange Docs or Guide HOT 1
- Include StackStorm Web UI overview in st2docs
- Orquesta not listed on available runners
- make docker-build missing curl
- Some part of captions are missing on the left side navigation menu. HOT 3
- Global RBAC permissions needs to be documented HOT 2
- Use of env variable for actions has no example HOT 1
- Migrate from CircleCI to GH Actions
- Migrate docs.stackstorm.com to GH static pages HOT 10
- StackStorm-HA Docs: Update reference links for Mongo/RabbitMQ dependencies helm charts for accuracy
- Centos 8 EOL HOT 2
- Documented instructions for RBAC role permissions are incorrect HOT 9
- Fix link structure of Orquesta Docs in the docs sidebar HOT 1
- how to solve curl 60 HOT 1
- StackStorm HA `helm install` instructions
- Docs Ubuntu 20.04 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from st2docs.