How to Use Exclude Content Macro

Introduction

External Share for Jira is a Jira add-on that allows users to share spaces and work items with individuals outside of their organization. In certain cases, specific content, such as sensitive information or proprietary data, should not be shared externally. To address this concern, the "exclude content macro" can be utilized to exclude particular content from external sharing. It is essential to be aware of the potential risks and implement strategies to avoid unintentional exposure of sensitive information.

Using the Exclude Content Macro

Follow these steps to use the exclude content macro in External Share for Jira:

1. Create or edit an work item in Jira and identify the content you want to exclude from sharing.

2. Insert the "exclude content macro" around the content you want to exclude by typing <Hide start> and <Hide end>.
   Use inline-code format and make sure to place the content in between the two code blocks.
   EXMAPLE: <Hide start> information irrelevant for external user <Hide end>

3. Save the work item, create an external share link, and view the work item to ensure excluded content is no longer visible when viewing the work item externally.

Important Risks and Considerations

Be aware of the following risks and considerations when using the "exclude content macro":

Editing Mode

If the "Allow Editing" option is enabled for the external share, external users can access edit mode, which will display hidden parts and allow them to edit the content. To mitigate this risk, consider disabling the "Allow Editing" option for the share or only granting editing access to trusted external users.

Search Excerpts

Since it is not possible to disable the search feature entirely, excluded content may still appear in search excerpts on the external share, potentially exposing sensitive information to external users. To minimize this risk, you can remove the search feature from the UI; however, be mindful that the search endpoint cannot be disabled.

Macro Placement

If the "exclude content macro" is used in a table, it will only affect the table cell where it is placed. Ensure proper placement of the macro to exclude the desired content.

End Macro Type

In the absence of an "End" exclude macro type (<Hide end>), everything after the "Start" type
(<Hide start>) will be removed.
Ensure both "Start" and "End" types are correctly placed to avoid unintended exclusion of content.

Conclusion

The "exclude content macro" is a valuable tool for controlling what content is shared externally while still allowing you to edit and manage the content as needed. By following the steps outlined above and being mindful of the potential risks, you can effectively exclude specific content from external sharing in Jira and Irrelevant for external users.