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.

[V2] Versioning Suggestions

See original GitHub issue

šŸ’„ Proposal

Hi! As I work on developing my Docusaurus site (https://squirrelly.js.org), I’ve noticed a few problems with the current versioning system.

  1. Pages aren’t versioned. This is a problem for me because on one page I host a live playground, and the syntax changes completely between the new and old libraries.
  2. docusaurus.config.js isn’t versioned. In my top bar, I link to different docs files. However, no matter what version I’m viewing, they always link to the latest docs (ex. /docs/ instead of docs/some-version/).
  3. There’s no way to get the current version in your React Components, so, for example, on the Docusaurus site, the link next to Docusaurus always reads alpha.43, no matter what version you’re currently viewing.

With these problems in mind, I’d suggest having a public version variable. This could be provided to MDX files, similarly to withBaseUrl. It would also be nice if you could, in docusaurus.config.js, export a function that accepted a version string as the parameter.

Have you read the Contributing Guidelines on issues?

Yes

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:3
  • Comments:26 (11 by maintainers)

github_iconTop GitHub Comments

4reactions
lex111commented, Feb 26, 2020

We will add the useVersion hook, the more we need it to show the version of docs in navbar.

2reactions
bravo-kernelcommented, Jun 11, 2020

Exactly, this:

If you want v4 and v5 as the same unified SPA under same domain: as far as I understand, what you would like is to have /docs instead of /docs/next ? ie v5 is the current ā€œwork in progress versionā€, and you want to edit files in ./docs directly?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Semantic Versioning 2.0.0 | Semantic Versioning
In systems with many dependencies, releasing new package versions can quickly become a nightmare. If the dependency specifications are too tight, you are...
Read more >
Best Practices When Versioning a Release | Cloudbees Blog
Five Tips for Implementing Semantic Versioning Ā· 1 - Communicate clearly to your users Ā· 2 - Have an open release schedule (that...
Read more >
Best Practices When Versioning a Release - LinkedIn
1. Communicate clearly to your users Ā· 2. Have an open release schedule (that changes gradually) Ā· 3. Be consistent and predictable Ā·...
Read more >
Software versioning - Wikipedia
Software versioning is the process of assigning either unique version names or unique version numbers to unique states of computer software.
Read more >
API Versioning Do's and Don'ts. It's never too ... - Bits and Pieces
Versioning strategy. The whole idea of this article is that you need to have a way to organize the way you version your...
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