Editing JoggrDocs
At Joggr, we believe technical documentation should be versioned and reviewed just like we (software developers) do with our code. That's why we've built versioned documentation. By versioning and reviewing documentation just like code, you can enjoy the same benefits, including:
- Enhanced quality and consistency in your documentation
- Improved knowledge sharing across your team
- Reduced documentation drift, ensuring your docs stay current and relevant
Read on to learn more about how to create versioned documentation, edit these versions, and merge them into your codebase.
What is versioned documentation? Just like we (software developers) version our code & review every change via a Pull Request, Joggr allows you to follow the same workflow for your docs. In short, when you edit a JoggrDoc, you create a version of the document that is reviewed in a Pull Request and then merged into your codebase.
Create a Versioned JoggrDoc
Follow the steps below to create a version of a document.
- Go to a JoggrDoc that has already been created and merged into your default branch.
- Edit the JoggrDoc.
- Commit to an existing PR or create a new PR.
- You now have another version of the same document! 🎉
You view the difference between your versioned JoggrDoc and the JoggrDoc on the default branch by flipping back & forth using the version dropdown (see the tutorial below) or visit the GitHub Pull Request.
Tip: Although you can commit directly to the default branch, we highly recommend you put all documentation through a review, so that you can reap the benefits.
Edit a Versioned JoggrDoc
When we (software developers) open a pull request for a code review, we often continue to commit changes to this pull request as we get feedback from the team. With Joggr, you can complete the same workflow for your documentation. Simply, edit your JoggrDoc and continue to commit changes to the same pull request as you get feedback from your team.
Warning: Make sure you edit the correct version of the document. Sometimes users accidentally make changes to the default branch instead of the versioned JoggrDoc.
Watch the short tutorial to see how you can continue edit your versioned JoggrDoc as you get feedback from your team.
Merge a Versioned JoggrDoc
Once you’re done with your revisions, you can merge your JoggrDoc just like you do your code. Go to GitHub and merge the Pull Request. Then, refresh Joggr and you will see that the only version that exists is the default branch!
You have now succesfully versioned, reviewed, and merged documentation just like you do code! 🎉