> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/platform-documentation/advanced-topics/version-control/version-control-getting-started.md). # Version Control: Getting Started ## Introduction Before the release of the LogicNets Version Control function, users assigned to the same Designer workspace and working on the same project had difficulty collaborating on content. With Version Control, you can enter projects into the version control feature to ensure the following: * The project can only be edited by a user in one workspace at any given time. * All changes to a project during the edit cycle are contained within a controlled revision number. * All users can still view and test the current project and any of its prior revisions. This article explains how to get started using version control, and specifically addresses the following: * How to initiate version control on a project * How to check out a project and check in changes * How to view and update a project's revision history * How to release a locked project Version control can be configured to be group-based or a stricter individual level of control. See [this](/release-9/platform-documentation/advanced-topics/version-control/team-group-vs-individual-strict-version-control.md) article for more information on this topic. ## Initiate Version Control To place a project into version control, do the following: ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-0ee79717ee39c7decafe2ef5d4320b7ab05dee1f%2F6985268d-393e-40d5-8521-196395b7312c.png?alt=media) * Click *Create Revision.* * Select a status: *Draft*, *Beta*, or *Release* * Add revision notes. We suggest adding information such as *Initial Release* or details on the specific functionality you added or updated. You can resize the notes box to accept more information. Use the *\[Enter key]* to add details on a new line. ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-d56bc6e5f22c2692f293fd40c33459994f1dfde2%2F871193cd-dd26-4d54-a2ef-cae1aa81db6f.png?alt=media) * \[optional] Click *Modify* to add author and version details. * Author - This could be the owner of the module or the name of the authoring team, for example. * Version - This is the "outward facing" release version, as opposed to the unique incremental revision number. * Description ## Check Out a Project, Edit, and Check in Changes If a project is in version control and it is available to check out the system displays the modified blue folder icon like the one in Project A in the screenshot below. ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-28516ebe80f1066cc89ee147a409795c91c14e5d%2Fdca6e291-d528-4465-abb7-b3743bd01a0c.png?alt=media) ### Check-Out Process To check out a project, click the project name in the projects folder and click *Check Out Revision.* The system verifies your access rights and confirms the project is now checked out with an on-screen message. If the system displays an error message, see [this article](/release-9/platform-documentation/advanced-topics/shared-workspaces/troubleshooting-version-control-and-shared-workspaces.md) for troubleshooting help. Once you have checked out a project, you can make any changes to the project details, including the location of the project in the folder structure, all logicnets, and resources (CSS, images, content resources, data tables) as required. During this time: * The project remains checked out to the workspace, even if you log out of the system. * Other users with local access to the workspace will be able to see your changes and make additional changes. * Users without local access to the workspace will not be able to modify the project. * If someone tries to check out the project the system displays a popup message saying the project is already checked out to another user. * They will still be able to view and test the project in its prior state. None of the changes you made are visible in other workspaces until you check them in. * See the [Team vs Individual Version Control](/release-9/platform-documentation/advanced-topics/version-control/team-group-vs-individual-strict-version-control.md) article for more information. ### Check-In Process When you are done making changes you can check in the changes or discard them by choosing one of the following options: * *Discard Revision* - The system does not save any changes and discards the project changelog. * *Check In Revision -* If you choose this option the system opens a popup window in which you can add status and revision notes. ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-8f24003021f0de4dbdb5cc193a7aad0a640009c4%2Ff9447de3-7735-46e3-9144-55d4ea8214aa.png?alt=media) #### Revision Status *Draft*, *Beta*, *Release* statuses are available in the dropdown menu. LogicNets added options *Discontinued* and *Restricted* in Release 8.3. *Draft*, *Beta*, *Release, Discontinued* status are available as meta data for revisions. They have no other related functionality or purpose. If you have been assigned the version control admin workspace role, you will have the additional option to mark the version *Restricted*. This status means that only those Designer users with the (version control) admin workspace role will be able to see, edit notes for, or revert to this version. Other users cannot see restricted versions. To retrieve a version from Restricted status, edit the revision notes and change the status to one of the other options. The system will make the revision available to all Designer users through the revision history tab. Once you have checked in a revision, the project is then available for authorized users with shared access to the workspace to check out. ## Project Revision History For any project under version control, the revision history table shows all activity, including user, check-in date, revision notes, and status. 1. Select the project and click on the *Revisions* tab to view the revision history. The system shows the active revision in bold. NOTE: This may or may not be the latest revision. 2. Click the *Edit* button to update Revision Status and/or Revision Notes. 3. Click the *Revert* button to update to a later version (not shown) or revert to a prior version. ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-4275a95acaf670ffd15253a9405bc7490e6fdc60%2Ff1311822-53b2-4bad-a647-81fb4e19bc2b.png?alt=media) ## Release a Locked Project from Version Control There are two scenarios where you may want to force the project's version control status. Both scenarios below require that you have "admin" rights for the workspace in question. These are assigned in the User Management package. ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-9646c1ee886d947467567fd3f40bbaf6ed268880%2F82e8a1a4-0bef-45ce-92c5-4a0de28ef8e4.png?alt=media) ### Force-Release Lock If a Designer user checked out the project and left it in that status, no other users with shared access to the workspace can check out the same project or update it, unless a Workspace Admin clicks *Force Release Lock* for that project. This discards any in progress changes and returns the project to the checked-in status, allowing others to check out the project. NOTE: Remember that the project is checked out to a workspace, so any other user with access to that workspace can check a project in or discard revisions, if the original user is out of office. See [Team vs Individual Version Control](/release-9/platform-documentation/advanced-topics/version-control/team-group-vs-individual-strict-version-control.md) for more details. ### Unlink Unlinking the project removes all version control, discards all revisions, and returns the project to its original status. This makes it editable at any time by any Designer user with appropriate access to the local workspace. NOTE: When working with shared workspaces, unlinking still creates a local project but leaves the original project under version control in the shared workspace. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://community-test.logicnets.com/release-9/platform-documentation/advanced-topics/version-control/version-control-getting-started.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.