Comments (5)
Hi @flimzy, we can certainly create a 2.0.x branch (immediately from the 2.0.0 label) but it's important to note that https://docs.couchdb.org/en/2.0.0/ will always reflect the content of the 2.0.0 tag, as will the contents of our 2.0.0 release tarball which is frozen at this point.
The branch will only be used if we decide to release a 2.0.1, which seems unlikely at this point.
from couchdb-documentation.
Is there any way to update documentation for corrections, after a release is made?
from couchdb-documentation.
Once we release 2.1 and tag 2.1.0
in the repo, the default https://docs.couchdb.org/ page will redirect to https://docs.couchdb.org/en/2.1.0/. So unless people specifically click on the 2.0.0
link in the documentation footer, they'll always get the updated docs by default. And the 2.0.0 link in the footer will always redirect to the 2.0.0
tag, which we shouldn't (and won't) move. We also can't go back and update the docs we shipped in the 2.0.0 tarball, that asset is frozen.
We could have a 2.0.x link in the website's footer that would follow the 2.0.x
branch, but I think that would confuse people. The other thing we could do is release a 2.0.1 with various patches and updated docs, at which point we could tag the docs for 2.0.1 and there'd be a link to that on the website. (That'd require a whole lot of cherry-picking, for what it's worth. 😿 )
@rnewson you were asking about this at one point as well, any opinions?
from couchdb-documentation.
That all makes sense. It's a bit unfortunate; I wish it was possible to improve the documentation on the web site, for previous versions. The 1.6 documentation is in a pretty bad state, and while the 2.0 docs are better, there are still a large number of inaccuracies. In both cases, I think the community could greatly benefit from updated, version-specific docs.
from couchdb-documentation.
I agree. The "right" thing to do is to release a 1.6.2 or 2.0.1 with fixes to the docs.
I'm open to other ideas. For now I'm going to close this ticket.
from couchdb-documentation.
Related Issues (20)
- error in string sorting HOT 1
- Documentation: misleading $title in Selector Basics section HOT 1
- `POST /{db}/index` seems to desribe old behaviour.
- Make it clear which version the docs are for
- Include the SSL FAQ content as a new page in the docs HOT 1
- MacOS installation guide download link is incorrect HOT 2
- Outdated JavaScript development tips HOT 1
- Remove partial filter selector field from POST /{db}/_index query parameters list HOT 1
- Replace all references to couch_httpd_auth with chttpd_auth HOT 2
- Document query_response option HOT 3
- Documentation on 3.1.1 version includes `$keyMapMatch` operator, which is missing in tag version. HOT 1
- Adding an information about max_partition_limit in the Partition Database introduction section
- Broken links (and problably travis build) because they are pointing to old master branch HOT 1
- Broken links on Installation pages HOT 2
- Reverse Proxying CouchDB in a subdirectory with nginx example does not handle URL encoded path fragments HOT 1
- Fix timeout time-unit (milliseconds instead of seconds) in /_db_updates doc page HOT 1
- I can't update couch-db via sudo apt-get update in Debain 10, I got 403 forbidden error message! HOT 2
- Couchdb repository is forbidden. HOT 1
- Linux installation information is incorrect - bintray.com service has been shut down by JFrog HOT 1
- no progress field when GET /_active_tasks HTTP/1.1 HOT 9
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 couchdb-documentation.