Skip to content

Merge admin and developer documentation into single mkdocs project#7413

Draft
Copilot wants to merge 4 commits intodevelopfrom
copilot/merge-admin-developer-docs
Draft

Merge admin and developer documentation into single mkdocs project#7413
Copilot wants to merge 4 commits intodevelopfrom
copilot/merge-admin-developer-docs

Conversation

Copy link
Contributor

Copilot AI commented Feb 26, 2026

Two separate mkdocs projects (docs/guides/admin/ and docs/guides/developer/) needed to be unified into one, with admin as the root structure and developer content under a subdirectory.

Documentation structure

  • Copied all developer docs into docs/guides/admin/docs/developer/, preserving relative paths for images and cross-references
  • Added developer nav sections under a top-level "Developer Documentation" entry in admin/mkdocs.yml
  • Added developer CSS (font-awesome.min.css, style-guide.css) to extra_css
  • Renamed site to "Opencast Documentation"
  • Removed the docs/guides/developer/ directory entirely

Macro compatibility

admin/main.py returned a string from opencast_major_version(); developer docs use it in arithmetic (version + 1). Changed return type to int — consistent with developer/main.py and backward-compatible since Jinja2 coerces int→str in string contexts.

Committer list generation

  • Moved .generate-list-of-committers.sh from docs/guides/developer/ to docs/guides/admin/ and updated its output path to docs/developer/participate/list-of-committers.md.include
  • Updated {% include %} path in committer.md accordingly

CI / build tooling

  • deploy-documentation.yml: generates the committer list from docs/guides/admin/ before building; only builds and deploys the merged admin site (no separate developer/site artifact)
  • check-docs.sh: changed loop from admin developer to admin only
  • package.json: removed ./developer/**/*.md from markdownlint script

Landing page

Replaced the two-column Adopters Guide + Developer Guide layout in .infrastructure/index.html.j2 with a single "Opencast Documentation" version dropdown pointing to /admin.

Original prompt

This section details on the original issue you should resolve

<issue_title>Merge admin and developer documentation</issue_title>
<issue_description>We currently have to documentation pages which are separated from each other:

  • The admin and adopters documentation live in docs/guides/admin/
  • The developers documentation lives in docs/guides/developer/

Both documentations are built separately. Both are mkdocs based documentation projects.

We want to:

  • Merge both documentations so that we have but one documentation project
  • The admin documentation is more important, so the structure should mainly be kepi intact. The developer documentation can mostly go into one or more sub-directories of the new, merged documentation.

Additional to just merging the two mkdocs projects we also need to:

  • Adjust the landing page in docs/guides/.infrastructure which currently links both types of documentation. It's okay to lose access to older versions of the development docs. But the landing page needs to be adjusted to only link the common documentation from now on.
  • Possibly adjust docs/guides/.markdownlint.yml to properly lint the newly merged documentation
  • Fix how the documentation is built in .github/workflows/deploy-documentation.yml and .github/workflows/test-documentation-build.yml so the merged documentation is properly built and deployed</issue_description>

<agent_instructions>Follow the hints and instructions in the issue description. Test building the documentation if possible. Make sure markdownlint doesn't find any errors in the merged documentation.</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits February 26, 2026 00:09
Co-authored-by: lkiesow <1008395+lkiesow@users.noreply.github.com>
Co-authored-by: lkiesow <1008395+lkiesow@users.noreply.github.com>
Copilot AI changed the title [WIP] Merge admin and developer documentation into one project Merge admin and developer documentation into single mkdocs project Feb 26, 2026
entitled to a vote (though they do get to participate in the discussion).

<!-- List of committers. Will be auto-generated -->
{% include 'developer/participate/list-of-committers.md.include' %}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would still like this to be auto-generated. Obviously, this cannot happen in the devloper folder any longer but needs to happen in the new documentation location.

This also means that we still need to code to generate this list in main.py and that generating the list of committers cannot be removed from the GitHub Actions workflow.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script is now at docs/guides/admin/.generate-list-of-committers.sh with the output path updated to docs/developer/participate/list-of-committers.md.include. The generate list of committers step has been added back to the deploy workflow, running from docs/guides/admin/ before the build step. Done in commit 8515c9d.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This script is not being run, or the generated documentation does not contain the output of this script.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this still live in the developer folder. The folder should be removed completely and everything should be moved to the new documentation location.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved .generate-list-of-committers.sh to docs/guides/admin/ and removed the entire docs/guides/developer/ directory in commit 8515c9d.

Co-authored-by: lkiesow <1008395+lkiesow@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 26, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • unpkg.com
    • Triggering command: /home/REDACTED/.local/bin/mkdocs mkdocs build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copy link
Member

@gregorydlogan gregorydlogan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's see how Copilot handles these.

</ul>
</div>
</div>
<div class="col-md-6">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section should remain, but link to the correct place in the documentation.

#GITHUB_PA_TOKEN=<personal-github-access-token>

OUT=docs/participate/list-of-committers.md.include
OUT=docs/developer/participate/list-of-committers.md.include
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path is wrong, which is why the list of committers is missing.

- WebVTT to CutMarks Operation: "workflowoperationhandlers/webvtt-to-cutmarks.md"
- Zip: "workflowoperationhandlers/zip-woh.md"
- Developer Documentation:
- Participate:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reorganize the Participate section so that the list is in alphabetical order.

- Maven repository: 'developer/participate/infrastructure/maven-repository.md'
- Packaging: 'developer/participate/infrastructure/packaging.md'
- Proposal log: 'developer/participate/proposal-log.md'
- Develop:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename Develop to be Development

@github-actions
Copy link
Contributor

This pull request has conflicts ☹
Please resolve those so we can review the pull request.
Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Merge admin and developer documentation

3 participants