Managing and publishing

Do you need to QA test new guides against the next great release of your application? What if you have a great new version of your app coming out next week? Updates often mean that the steps to complete a task change and sometimes even the elements you’re asking people to click on disappear completely. You need a way to update your walkthroughs to prepare them for your next release. And you need to do this without disrupting your current site.

With our version control tools, you can safely develop and test on your staging environment and push to production when you're ready to go live. Watch the video below and find out more.

Version Control Overview

Version control system in Inline Manual is similar to what developers use, such as Git or Subversion. It helps you manage changes to topics over time. It records every modification made. All of your content in Inline Manual is under a version control system so you can go back and forth in history, and revert to previous states You can see the complete change history including the author, dates, and edits made to the content. With that, you’re able to fully compare and analyze topics. Use version control to prevent mistakes and work more effectively.

You’ll notice we use the same language as developers use, so you can keep your releases in sync.

· HEAD - the current and latest updated version of your tutorials.
· Revision - each time you edit a topic, a new revision is created. This means you can see when the content was changed and also revert back to previous states.
· Release - this is a named state of revision. You can create a release and name it, for example, Version 1.1 to indicate it’s one step ahead of Version 1.0.

Next, deploy your changes to your site by assigning the release to a specific topic on a site.

Deployment

You can create multiple sites in Inline Manual. Each site in Inline Manual has a unique player ID you install into your environments. Lite accounts can have one “live” site and other sites for testing. Standard accounts and higher can have unlimited sites. Check our pricing page for a comparison.

We recommend you have one site for your production environment, and one for staging. On the production site, you’ll have all the topics you have tested and know are working. On your staging site, you can add individual topics as you need to test them.

Was this article helpful?