Uploaded image for project: 'Compass'
  1. Compass
  2. COMPASS-41

Reintroduce syncing of Document Links with CAC, without affected Document Links added manually by users.

    • 2
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      Issue Summary

      • In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of Config As a Code (CAC) support.
      • Customers are expecting a behaviour that CAC is the source of truth for Document links or Components when CAC is available. 
      • Document Links can be added manually or via API even with CAC enabled

      Expected Results

      • Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
      • Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.

      Current Behaviour

      The current behaviour is that Document Links can only be updated manually.

       

      Workaround

      Currently there is no known workaround for this behavior. A workaround will be added here when available

       

       

            [COMPASS-41] Reintroduce syncing of Document Links with CAC, without affected Document Links added manually by users.

            I’m really hoping to see support for managing Documentation Links via config-as-code reintroduced soon. The current experience can be confusing, since some links are managed through config-as-code on the home page, while documentation links have to be added manually. The inconsistency makes it harder to maintain a clear standard across our org.

            Is there any update on when this functionality might be available again, or if there’s a planned timeline for its rollout? Thanks!

            DarrenDooley added a comment - I’m really hoping to see support for managing Documentation Links via config-as-code reintroduced soon. The current experience can be confusing, since some links are managed through config-as-code on the home page, while documentation links have to be added manually. The inconsistency makes it harder to maintain a clear standard across our org. Is there any update on when this functionality might be available again, or if there’s a planned timeline for its rollout? Thanks!
            SET Analytics Bot made changes -
            Support reference count New: 2
            Pravin made changes -
            Description Original: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of Config As a Code (CAC) support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API even with CAC enabled

            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.
             * Update documentation to state that Category is now mandatory.

            h3. Current Behaviour

            The current behaviour is that Document Links can only be updated manually.

             
            h3. Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            New: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of Config As a Code (CAC) support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API even with CAC enabled

            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.

            h3. Current Behaviour

            The current behaviour is that Document Links can only be updated manually.

             
            h3. Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            Pravin made changes -
            Description Original: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of Config As a Code (CAC) support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.

            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.
             * Update documentation to state that Category is now mandatory.

            h3. Current Behaviour

            The current behaviour is that Document Links can only be updated manually.

             
            h3. Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            New: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of Config As a Code (CAC) support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API even with CAC enabled

            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.
             * Update documentation to state that Category is now mandatory.

            h3. Current Behaviour

            The current behaviour is that Document Links can only be updated manually.

             
            h3. Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            Pravin made changes -
            Description Original: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of CAC support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.
             *  

            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.
             * Update documentation to state that Category is now mandatory.

            h3. Current Behaviour

            The current behaviour is that Document Links can only be updated manually.

             
            h3. Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            New: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of Config As a Code (CAC) support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.

            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.
             * Update documentation to state that Category is now mandatory.

            h3. Current Behaviour

            The current behaviour is that Document Links can only be updated manually.

             
            h3. Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            Jonathan Andrew made changes -
            Description Original: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of CAC support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.
             *  

            h3. Steps to Reproduce
            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.
             * Update documentation to state that Category is now mandatory.

            h3. Actual Results

            The current behaviour is that Document Links can only be updated manually.

             

            Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            New: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of CAC support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.
             *  

            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.
             * Update documentation to state that Category is now mandatory.

            h3. Current Behaviour

            The current behaviour is that Document Links can only be updated manually.

             
            h3. Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            Jonathan Andrew made changes -
            Description Original: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of CAC support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.
             *  

            h3. Steps to Reproduce
            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.

            h3. Actual Results

            The current behaviour is that Document Links can only be updated manually.

             

            Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            New: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of CAC support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.
             *  

            h3. Steps to Reproduce
            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.
             * Update documentation to state that Category is now mandatory.

            h3. Actual Results

            The current behaviour is that Document Links can only be updated manually.

             

            Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            Jonathan Andrew made changes -
            Description Original: h3. Issue Summary
             * In early August, Document Links was updated to include a Category field, and the location of document links was moved, which resulted in the removal of CAC support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.
             *  

            h3. Steps to Reproduce
            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly.
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.

            h3. Actual Results

            The current behaviour is that Document Links can only be updated manually.

             

            Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            New: h3. Issue Summary
             * In early August, Document Links was updated to include a mandatory Category field, and the location of document links was moved, which resulted in the removal of CAC support.
             * Customers are expecting a behaviour that CAC is the *source of truth* for Document links or Components when CAC is available. 
             * Document Links can be added manually or via API.
             *  

            h3. Steps to Reproduce
            h3. Expected Results
             * Document Links should be synced with CAC file and any changes to the file are recognized by Compass and added/removed accordingly. If Category is empty, set it to Others
             * Document Links that were added manually via GUI or API should not be removed if they are not contained in the CAC file, to minimize breaking changes to customers' data when this feature is reintroduced.

            h3. Actual Results

            The current behaviour is that Document Links can only be updated manually.

             

            Workaround

            Currently there is no known workaround for this behavior. A workaround will be added here when available

             

             
            Jonathan Andrew created issue -

              Unassigned Unassigned
              39365a44c525 Jonathan Andrew
              Votes:
              2 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: