Comments (3)
I looked into this today, I think the process would be:
- Create new branches with the right names (0.2.0, 0.1.0, 0.0.3, 0.0.2, 0.0.1) by branching off the existing ones
- Enable those branches in read the docs and build them (note you need to manually run a build of something to pick up new branches which don't have any new commits)
- Set up exact redirects in the RTD admin along the lines of:
/en/v0-2-0/$rest
->/en/0.2.0/
(one for each version, plus one for the languages we've already published content under, e.g./ru/v0-2-0/$rest
->/ru/v0.2.0/
. Only v0-2-0 has other languages thanen
. Note that after testing, the$rest
works for every page except the root, which needs a dedicated redirect as well - Set the default version and default branch to
0.2.0
instead ofv0-2-0
. - Disable the old branches in read the docs
- Remove the manually added old version links in v0-0-1, 2 and 3 (v0-1's is disappearing anyway in openownership/data-standard#305)
- Update this documentation to use the new branch scheme names and links
-
Update any outstanding PRs to rebase them onto the right branches - (Eventually) delete the old branches in github
I've run a test with v0-0-1 and v0-0-2 now to make sure this works as expected, which I'll leave up for someone else to confirm. It's slightly flawed in that 0.0.1 points to 0.0.2 as the latest, since rtd doesn't recognise any others, but I don't think that matters for a few days.
@Bjwebb / @odscjames - would one of you have time to look at this list and double check I haven't missed anything? If not, I'll make these changes next week. In particular, I'm wondering if the original naming scheme was chosen for any particular reason, and if we need to do anything in our custom theme? (I don't think so on the latter, though we may want to add some css to style it better?).
from bods-dev-handbook.
@stevenday I've glanced through the list, and it looks good. @odscjames might want to take a look too.
from bods-dev-handbook.
I've done almost all these steps today, except for updating the docs and deleting old branches (there are no outstanding PRs against them). I had to do these a bit unilaterally because after I deployed the theme changes for the standard, I ended up with some stale read the docs versions that no other options seemed to fix. I'll add a PR for the docs in a moment to close this off.
from bods-dev-handbook.
Related Issues (13)
- Add branching policy/guidance HOT 1
- Codelist capitalisation
- "you must always use the bracket notation" HOT 1
- Update docs section of the handbook HOT 1
- Write docs on creating and maintaining SVG diagrams HOT 1
- Add guidance on maintenance of the reference.rst page HOT 8
- FYI, OCDS considering moving its handbook to Gitbook HOT 1
- Add translation guidance from data-standard README
- FYI, OCDS using Airtable for tools HOT 1
- Document how codelists are managed for BODS HOT 2
- Draft a style guide HOT 2
- Write documention that describes how to run and add tests in schema repo HOT 4
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 bods-dev-handbook.