Merge admin and developer documentation into single mkdocs project#7413
Merge admin and developer documentation into single mkdocs project#7413
Conversation
Co-authored-by: lkiesow <1008395+lkiesow@users.noreply.github.com>
Co-authored-by: lkiesow <1008395+lkiesow@users.noreply.github.com>
| 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' %} |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
This script is not being run, or the generated documentation does not contain the output of this script.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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>
|
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:
If you need me to access, download, or install something from one of these locations, you can either:
|
gregorydlogan
left a comment
There was a problem hiding this comment.
Let's see how Copilot handles these.
| </ul> | ||
| </div> | ||
| </div> | ||
| <div class="col-md-6"> |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
Rename Develop to be Development
|
This pull request has conflicts ☹ |
Two separate mkdocs projects (
docs/guides/admin/anddocs/guides/developer/) needed to be unified into one, with admin as the root structure and developer content under a subdirectory.Documentation structure
docs/guides/admin/docs/developer/, preserving relative paths for images and cross-referencesadmin/mkdocs.ymlfont-awesome.min.css,style-guide.css) toextra_cssdocs/guides/developer/directory entirelyMacro compatibility
admin/main.pyreturned a string fromopencast_major_version(); developer docs use it in arithmetic (version + 1). Changed return type toint— consistent withdeveloper/main.pyand backward-compatible since Jinja2 coerces int→str in string contexts.Committer list generation
.generate-list-of-committers.shfromdocs/guides/developer/todocs/guides/admin/and updated its output path todocs/developer/participate/list-of-committers.md.include{% include %}path incommitter.mdaccordinglyCI / build tooling
deploy-documentation.yml: generates the committer list fromdocs/guides/admin/before building; only builds and deploys the merged admin site (no separatedeveloper/siteartifact)check-docs.sh: changed loop fromadmin developertoadminonlypackage.json: removed./developer/**/*.mdfrom markdownlint scriptLanding page
Replaced the two-column Adopters Guide + Developer Guide layout in
.infrastructure/index.html.j2with a single "Opencast Documentation" version dropdown pointing to/admin.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.