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.

Ability to turn off the "next" version / make editing docs easier

See original GitHub issue

šŸ’„ Proposal

After cutting a version (eg 1.0.0), the docs exist at both docs/ and versioned_docs/version-1.0.0. If for instance, I want to fix a typo, it seems like I would have to edit both copies anytime a change is made?

It seems like the versioning feature presumes I want a next version. However, I only just released 1.0.0 with no breaking changes under development, so I don’t need or want a ā€œnextā€ version, as it’s just another place I have to maintain, and an additional point of confusion for my users.

Also, I’d like to be able to work on the structure of & improve my 1.0.0 docs, without having to create a new version of my library.

As a workaround, I have to make sure if a file exists in both folders to edit the ā€œversionedā€ doc, and then run rsync -avr ./versioned_docs/version-1.0.0/ ./docs/ to make sure next (which I don’t actually want) stays updated. Or another workaround is

āžœ  rx-store-website git:(master) rm -fr versioned_docs/version-1.0 versioned_sidebars/version-1.0-sidebars.json 
āžœ  rx-store-website git:(master) āœ— ../../node_modules/.bin/docusaurus docs:version 1.0      

One way to solve this would be to update versions.json with a 1.0.0 entry, but have it point to ā€œdocsā€ folder. Only later if & when I cut a new version would the ā€œversioned docsā€ for 1.0.0 be added, so it’d archive a version at the time it reaches end of life instead of when the version is released would be an improvement IMO. I think it’d also have to invert the diffing to work (eg, archive everything, since you don’t know what will change in future versions, then later when you archive another version on top of that is the point in time in which you’d prune files from the older versions that did not change)

Have you read the Contributing Guidelines on issues?

yes

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6

github_iconTop GitHub Comments

1reaction
joshribakoffcommented, Aug 17, 2020

I’ve bookmarked the RFC to read later, what you described sounds exactly like it will solve the issue, and the workarounds I posted in the OP seem tenable in the meantime, so it is fine to remain closed. Thanks!

0reactions
joshribakoffcommented, Aug 27, 2020

Sounds like you already have the feature I was suggesting then and it just wasn’t super obvious. I’ll try it out again in the future. For now I turned off versions because it was a bit cumbersome to edit the dupes files. Thanks for the reply!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Help prevent changes to a final version of a file
After you click Mark as Final to mark a file as final, a message tells you that the file is marked as final...
Read more >
Suggest edits in Google Docs - Computer
Suggest changes to a file Ā· At the top right, click Editing edit and then from the drop-down, select Suggesting add suggestion ....
Read more >
Easily switch between editing, reviewing, and viewing ...
I'm excited to share that we've made it even easier to switch between editing, reviewing, and viewing your documents in Word for Windows....
Read more >
Using Google Docs Offline - GCF Global
Open Google Docs and locate the document you want to edit offline. Click the button with the three vertical dots, then click the...
Read more >
Google Docs: Online Document Editor | Google Workspace
With Docs, everyone's working on the latest version of a document. And with edits automatically saved in version history, it's easy to track...
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