question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

How should I organize a multi-version site?

See original GitHub issue

My Noda Time site hosts the API reference documentation for multiple versions (all past releases, and the current “unstable” code). Each version also has its own user guide, which needs to refer to the API reference.

Obviously these contain the same type and member names by and large, so even though I can easily generate the metadata (yml files) from the source of previous releases easily enough, I can’t use docfx build due to the collisions.

My current plan is to have a separate docfx.json file per release, build the sites as if they were entirely separate, and then stitch them together… but if there’s any better approach, I’d love to hear it.

(I considered post-processing the YML files to add the version number to disambiguate, but that would be awkward in various ways, and lead to ugly URLs.)

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Reactions:9
  • Comments:28 (9 by maintainers)

github_iconTop GitHub Comments

5reactions
thuannguycommented, Oct 9, 2019

What is the magic that docs.microsoft.com is using to do versioning? e.g. https://docs.microsoft.com/en-us/aspnet/core/tutorials/first-web-api?view=aspnetcore-3.0&tabs=visual-studio

Is that something that can work out of the box with DocFX or?

2reactions
superyyrrzzcommented, Oct 12, 2019

Not soon, but you can track it here: https://github.com/dotnet/docfx/blob/v3/docs/roadmap.md

Read more comments on GitHub >

github_iconTop Results From Across the Web

Creating Multi-version Manual
You can easily create a multi-version manual for different versions of your software. The main specific of a multi-version manual is that you...
Read more >
Add Multi-Version Support to Astro Apps - Bits and Pieces
Adding Multi-Version Support to Your Astro-based Documentation. How can you have multiple versions of the same page living inside your documentation?
Read more >
Creating and Grading Multi-Version Assignments
On the Assignments page, select Organize Exam Versions. ... For multi-version Exam and Homework assignments, you will grade each assignment ...
Read more >
An Efficient Multiversion Access Structure
sary to organize the data so that queries such as these can. be answered efficiently, while allowing for database-. modifying operations (also referred...
Read more >
Multi-version Upgrades: Alternate Approach
You can make the upgrade process a lot smoother by getting the site in a predictable state by removing recycle bin objects and...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found