Skip to main content

Update Documentation

The documentation below website/ comes in two parts. While website/dev/ contains documentation related to this repository (like this section here), website/docs/ contains the documentation for using the CoreMedia GlobalLink Connect Cloud Integration. This section is about updating the latter.

INFO: Auto-Deployment of Documentation

The documentation is deployed to an extra branch gh-pages. It is generated by Docusaurus and located within the website/ folder of this repository.

Deployment is done automatically from main branch, as soon as changes have been merged from a maintenance/* branch. You may always decide to run the deployment manually, of course.

For reference towards documentation.coremedia.com the documentation should use the MDX Component <DocLink>. If all documentation adheres to this pattern, updating versioned links just requires updating website/src/ts/context.ts.

b) Content Revision​

On each CMCC version update, we need to check if the documentation for administrators, editors and developers are still aligned with the product.

Unless we introduced new behaviors to the GCC integration, or the integration into CoreMedia Blueprint has to be adapted, there is nothing to be done here most of the time.

c) Screenshot Revision​

INFO: Skip for Minor Release Approval

Unless it is about documenting new features or behaviors, aligning screenshots, for example, to a new visual identity of CoreMedia, should just be considered for approval of new major versions.

The section "Editors" contains screenshots, that may require an update. Consider reading the corresponding How-to to guide you through the process (like resolutions to choose, etc.).

d) Third-Party Reports​

Used third-party libraries must be reported and their licenses integrated into the documentation (as at least some licenses require this). We only maintain these reports for our Maven/Java based modules.

To create a new report:

  • Ensure to have built the CMCC branch before (as most dependencies will be taken from corresponding parents or BOMs).

  • Run:

    mvn -Pdocs-third-party generate-resources

    This will update the auto-generated file website/docs/third-party/third-party.md as well as adding downloaded licenses to website/docs/third-party/files.

NOTE: Customizing Report

For generating the Markdown report third-party.md the FreeMarker template src/main/templates/third-party-md.ftl is used.