Comments (5)
I think we should stop using current
which would go a long way for this.
I think it is super reasonable to expect that a versioned link won't change, except for master
and the .x
links. Those are "development" branches are constantly being hacked. For the most part I think we should get permanent links by being disciplined about not moving things or leaving redirects when we do. Some tools might help here, but those are a little ways off.
from docs.
I think it is super reasonable to expect that a versioned link won't change, except for master and the .x links.
I agree, but I think some writers choose to backport these types of changes because it makes other backports easier and it makes the version switching work better. If you don't backport the changes, you get into a weird situation where switching versions drops you into an entirely different "book". (Hopefully our site redesign will improve this situation by making the content easier to navigate from a single pane, but right now, the user experience is sub-optimal.) I'm playing devil's advocate here because my preference is to NOT backport structural changes.
TBH, I am not a big fan of moving content between books/repos. Besides breaking everyone's bookmarks/links and making it harder for experienced users to find content, it essentially erases the original author's attribution in GitHub. (No one is going to run git log
to see the full history.) I feel like we've done that too much, and our users (including support) are getting whiplash.
from docs.
Links to the documentation should almost always use the versioned link rather than current.
from docs.
Documentation is ever changing. There are often broken links found in GH issues, Discuss posts and other places where current link was pasted. Sometimes even the versioned link changes, but this is less often. And getting the versioned link is cumbersome. Can the documentation please include a permalink that will NEVER change?
from docs.
@inqueue I'm curious if there are specific content areas where you're seeing a lot of churn that's causing you pain. I'm not sure about the permalink question (I'll leave that to @nik9000 to answer because I think our doc tools are a huge limitation here). However, writers should be setting up redirects to minimize broken links. If you are seeing a lot of broken links, that's a bug, and we need to fix it.
from docs.
Related Issues (20)
- Set max age of cache
- Formatting issue on documentation menu for Microsoft Edge HOT 3
- Validate shortened doc links HOT 3
- Create new attribute for "Elastic Defend"
- Fix broken links when master is changed to main
- Right hand side on Logstash plugins guide is too short HOT 4
- Add new landing page CSS to this repo HOT 2
- Add missing OpenGraph (og:) meta tags
- Adding the Android APM agent to the build
- Revisit information architecture for docs landing page and latest
- Fix air-gapped docs navigation HOT 1
- Remove Azure Marketplace and Resource Manager docs
- There is a link broken to the azure marketplace. Go here--> https://www.elastic.co/guide/index.html and scroll down to “Subscribe” and click on ‘Azure Marketplace’ (404 error) #1388 HOT 7
- Footnotes start with number 2 HOT 2
- linked worktrees unsupported when running `build_docs`
- [BUG] Notes section icon prevents characters from being selected
- Differences in the breaking change page for Kubernetes Autodiscover of all Beats
- The `Copy as curl` function doesn’t work for PATCH requests HOT 2
- Feedback from testing operator hub integration releasing ECK 2.12.0
- ESQL Docs: Copy as cURL and open in console for ESQL 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 docs.