Gretyl's Portal

Heretto Help

Show Page Sections

Create and Manage Docusaurus Publishing Scenarios

You can add, edit, remove, enable, and disable the Docusaurus publishing scenarios.

Tip: You can also locally develop Docusaurus templates and associate them with Docusaurus publishing scenarios.

Create a Docusaurus Scenario

Administrators can create Docusaurus publishing scenarios.

  1. In the top-left corner, click the Main Menu and go to Docusaurus.
  2. Click New scenario.
  3. In the New scenario window, fill in the Scenario name field.
  4. If you want to be able to deploy Docusaurus output to Netlify:
    1. If needed, configure the deployment environment for Docusaurus. See Configure Publishing for Docusaurus.
    2. From the Environment drop-down list, select a Netlify deployment environment.
    3. Select the Enable deployment to Netlify check box.
  5. Manage the Docusaurus templates:
    1. To add a new template, click Add new template and fill in the Template name and Name or Git URL fields.
      Template name field
      The name that will display in the Template drop-down list in the Publish window.
      Name or Git URL field
      One of the following:
      • A default Docusaurus template name (classic or bootstrap)
      • A URL to the Git repository with a custom template. For example, https://github.com/Jorsek/docusaurus-template.git
        Note:

        The GIT repository must be publicly available for Heretto CCMS to load it correctly.

    2. To remove a template, click the associated X button.
  6. Click Create.

Configure Publishing for Docusaurus

Administrators can define environments for Docusaurus publishing. Heretto CCMS provides an easy way of configuring Netlify, an easy to use hosting service. For more information, see netlify.com. You can use a different hosting service too.

  1. In the top-left corner, click Main Menu and go to Publishing Configuration.
  2. To create a new environment:
    1. In the docusaurus settings section, click Add new environment.
    2. In the Create Environment window, fill in the Environment Name field.
    3. Click Create.
    4. In the docusaurus settings section, fill in the Netlify API Token field (0Auth) of the environment that you created in 2.
      Tip: For more information, see the Netlify Documentation.
  3. To remove an environment, next to the environment, click remove.
  4. To modify an environment, edit the associated fields.
  5. Scroll down and click Save Changes.

Enable or Disable a Docusaurus Scenario

Administrators can show or hide a publishing scenario in the publishing interface.

  1. In the top-left corner, click the Main Menu and go to Docusaurus.
  2. Hover over a publishing scenario and click More actions .
  3. From the context menu, select an action:
    • To disable a publishing scenario, select Disable.
      Figure 1. Disabled publishing scenarios are not visible in the publishing interface
    • To enable a disabled publishing scenario, select Enable.
      Figure 2. Enabled publishing scenarios are visible in the publishing interface

Delete a Docusaurus Scenario

Administrators can delete publishing scenarios that are no longer needed.

  1. In the top-left corner, click the Main Menu and go to Docusaurus.
  2. Hover over a publishing scenario and click More actions .
  3. From the context menu, select Delete.
  4. If prompted, confirm the deletion.