Bug 2067852 - Migrate rst docs to markdown and host inside of bugzilla itself - #2731
Open
dklawren wants to merge 13 commits into
Open
Bug 2067852 - Migrate rst docs to markdown and host inside of bugzilla itself#2731dklawren wants to merge 13 commits into
dklawren wants to merge 13 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Migrates documentation from Sphinx/reStructuredText to Markdown served within Bugzilla.
Changes:
- Adds an in-app Markdown viewer, styling, navigation, and tests.
- Converts documentation and updates application links.
- Removes obsolete Sphinx, Read the Docs, and POD-generation infrastructure.
Reviewed changes
Copilot reviewed 128 out of 153 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
template/en/default/search/form.html.tmpl |
Updates relative-date documentation link. |
template/en/default/pages/doc_viewer.html.tmpl |
Adds the documentation viewer template. |
template/en/default/global/user-error.html.tmpl |
Adds a documentation 404 page. |
template/en/default/global/header.html.tmpl |
Always displays the documentation menu item. |
template/en/default/global/docslinks.html.tmpl |
Always renders available documentation links. |
template/en/default/bug/tagging.html.tmpl |
Updates tag documentation link. |
template/en/default/admin/params/general.html.tmpl |
Removes docs_urlbase configuration help. |
template/en/default/account/prefs/mfa.html.tmpl |
Updates MFA documentation link. |
template/en/default/account/prefs/apikey.html.tmpl |
Moves authentication help in-app. |
t/Support/Files.pm |
Removes the deleted documentation builder. |
t/mojo-docs.t |
Tests in-app documentation routing and rendering. |
skins/standard/docs.css |
Styles rendered Markdown documentation. |
Makefile.PL |
Removes the documentation build feature. |
js/util.js |
Updates REST API documentation URL. |
extensions/BugModal/web/attachments_overlay.js |
Updates attachment API documentation URL. |
docs/style.css |
Removes generated POD documentation styling. |
docs/makedocs.pl |
Removes the Sphinx/POD build script. |
docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm |
Removes POD batch-rendering support. |
docs/lib/Pod/Simple/HTML/Bugzilla.pm |
Removes POD HTML rendering support. |
docs/en/rst/using/tips.rst |
Removes the reStructuredText source. |
docs/en/rst/using/reports-and-charts.rst |
Removes the reStructuredText source. |
docs/en/rst/using/preferences.rst |
Removes the reStructuredText source. |
docs/en/rst/using/index.rst |
Removes the reStructuredText source. |
docs/en/rst/using/filing.rst |
Removes the reStructuredText source. |
docs/en/rst/using/extensions.rst |
Removes the reStructuredText source. |
docs/en/rst/using/editing.rst |
Removes the reStructuredText source. |
docs/en/rst/using/creating-an-account.rst |
Removes the reStructuredText source. |
docs/en/rst/style.rst |
Removes the reStructuredText style guide. |
docs/en/rst/requirements.txt |
Removes Sphinx dependencies. |
docs/en/rst/integrating/skins.rst |
Removes the reStructuredText source. |
docs/en/rst/integrating/languages.rst |
Removes the reStructuredText source. |
docs/en/rst/integrating/index.rst |
Removes the reStructuredText source. |
docs/en/rst/integrating/faq.rst |
Removes the reStructuredText source. |
docs/en/rst/integrating/extensions.rst |
Removes the reStructuredText source. |
docs/en/rst/integrating/auth0.rst |
Removes the reStructuredText source. |
docs/en/rst/integrating/apis.rst |
Removes the reStructuredText source. |
docs/en/rst/index.rst |
Removes the Sphinx documentation index. |
docs/en/rst/extensions/Webhooks/api/v1/webhooks.rst |
Removes the reStructuredText source. |
docs/en/rst/extensions/Webhooks/api/v1/index.rst |
Removes the reStructuredText source. |
docs/en/rst/api/integration.rst |
Removes the reStructuredText source. |
docs/en/rst/api/index.rst |
Removes the reStructuredText source. |
docs/en/rst/api/core/v1/reminders.rst |
Removes the reStructuredText source. |
docs/en/rst/api/core/v1/index.rst |
Removes the reStructuredText source. |
docs/en/rst/api/core/v1/general.rst |
Removes the reStructuredText source. |
docs/en/rst/api/core/v1/flag-activity.rst |
Removes the reStructuredText source. |
docs/en/rst/api/core/v1/component.rst |
Removes the reStructuredText source. |
docs/en/rst/api/core/v1/classification.rst |
Removes the reStructuredText source. |
docs/en/rst/api/core/v1/bugzilla.rst |
Removes the reStructuredText source. |
docs/en/rst/api/core/v1/bug-user-last-visit.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/workflow.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/whining.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/quips.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/preferences.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/keywords.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/index.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/groups.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/flags.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/field-values.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/extensions.rst |
Removes the reStructuredText source. |
docs/en/rst/administering/custom-fields.rst |
Removes the reStructuredText source. |
docs/en/rst/about/index.rst |
Removes the reStructuredText source. |
docs/en/rst/_static/bugzilla.css |
Removes Sphinx-specific styling. |
docs/en/md/using/tips.md |
Adds Markdown user tips. |
docs/en/md/using/reports-and-charts.md |
Adds Markdown reporting documentation. |
docs/en/md/using/preferences.md |
Adds Markdown preference documentation. |
docs/en/md/using/index.md |
Adds the Markdown user-guide index. |
docs/en/md/using/filing.md |
Adds Markdown bug-filing guidance. |
docs/en/md/using/extensions.md |
Adds extension documentation links. |
docs/en/md/using/editing.md |
Adds Markdown bug-editing guidance. |
docs/en/md/using/creating-an-account.md |
Adds account-creation guidance. |
docs/en/md/style.md |
Adds the Markdown documentation style guide. |
docs/en/md/integrating/skins.md |
Adds skin customization guidance. |
docs/en/md/integrating/languages.md |
Adds localization guidance. |
docs/en/md/integrating/index.md |
Adds the integration-guide index. |
docs/en/md/integrating/faq.md |
Adds the customization FAQ. |
docs/en/md/integrating/extensions.md |
Adds extension-development guidance. |
docs/en/md/integrating/auth0.md |
Adds Auth0 integration guidance. |
docs/en/md/integrating/apis.md |
Adds API selection guidance. |
docs/en/md/index.md |
Adds the main Markdown documentation index. |
docs/en/md/extensions/Webhooks/api/v1/webhooks.md |
Adds Webhooks API documentation. |
docs/en/md/extensions/Webhooks/api/v1/index.md |
Adds the Webhooks API index. |
docs/en/md/api/integration.md |
Adds integration best practices. |
docs/en/md/api/index.md |
Adds the API reference index. |
docs/en/md/api/core/v1/reminders.md |
Adds reminder API documentation. |
docs/en/md/api/core/v1/index.md |
Adds the core API index. |
docs/en/md/api/core/v1/flag-activity.md |
Adds flag-activity API documentation. |
docs/en/md/api/core/v1/component.md |
Adds component API documentation. |
docs/en/md/api/core/v1/classification.md |
Adds classification API documentation. |
docs/en/md/api/core/v1/bugzilla.md |
Adds Bugzilla information API documentation. |
docs/en/md/api/core/v1/bug-user-last-visit.md |
Adds last-visit API documentation. |
docs/en/md/administering/workflow.md |
Adds workflow administration guidance. |
docs/en/md/administering/whining.md |
Adds scheduled-report guidance. |
docs/en/md/administering/quips.md |
Adds quip administration guidance. |
docs/en/md/administering/preferences.md |
Adds default-preference guidance. |
docs/en/md/administering/keywords.md |
Adds keyword administration guidance. |
docs/en/md/administering/index.md |
Adds the administration index. |
docs/en/md/administering/flags.md |
Adds flag administration guidance. |
docs/en/md/administering/field-values.md |
Adds field-value guidance. |
docs/en/md/administering/extensions.md |
Adds installed-extension guidance. |
docs/en/md/administering/custom-fields.md |
Adds custom-field guidance. |
docs/en/md/about/index.md |
Adds documentation metadata and credits. |
docs/en/Makefile |
Removes Sphinx build targets. |
CONTRIBUTING.md |
Updates the README reference. |
contribute.json |
Points contributors to in-app documentation. |
conf/checksetup_answers.txt |
Removes the obsolete documentation URL setting. |
conf/checksetup_answers_suite.txt |
Removes the obsolete suite setting. |
Bugzilla/WebService/Server/REST.pm |
Updates REST error documentation URLs. |
Bugzilla/Template/Plugin/Hook.pm |
Updates extension documentation URL. |
Bugzilla/Template.pm |
Defines the in-app documentation base URL. |
Bugzilla/Markdown/GFM.pm |
Adds cmark rendering options. |
Bugzilla/Install/Requirements.pm |
Removes the documentation feature mapping. |
Bugzilla/Install/Filesystem.pm |
Removes generated-documentation permissions. |
Bugzilla/Config/General.pm |
Removes the docs_urlbase parameter. |
Bugzilla/App/Plugin/Error.pm |
Updates API error documentation URLs. |
.vscode/settings.json |
Removes Sphinx editor configuration. |
.readthedocs.yaml |
Removes Read the Docs configuration. |
Suppressed comments (2)
docs/en/md/extensions/Webhooks/api/v1/webhooks.md:49
- “Current enabled” should be “currently enabled.”
docs/en/md/extensions/Webhooks/api/v1/webhooks.md:50 - Correct the misspelling “encounted.”
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+3
to
+5
| This is the documentation for version 4.2 of Bugzilla, a bug-tracking system | ||
| from Mozilla. Bugzilla is an enterprise-class piece of software that tracks | ||
| millions of bugs and issues for thousands of organizations around the world. |
| ## Links Between Pages | ||
|
|
||
| Always link to other documentation pages with relative paths that include | ||
| the `.md` extension, e.g. `[User Guide](../using/index.md)`. These links |
Comment on lines
+974
to
+977
| # (Bugzilla::App::Controller::Docs). Kept as "docs_urlbase" so the | ||
| # many templates that build documentation links keep working; the | ||
| # viewer redirects legacy Sphinx-style .html paths to the Markdown | ||
| # pages. |
| file](../../images/bzLifecycle.xml) is available in | ||
| [Dia's](http://www.gnome.org/projects/dia) native XML format. | ||
|
|
||
|  |
Comment on lines
+6
to
+8
| NOTE: You will need to pass in a valid API key with the | ||
| `X-Bugzilla-API-Key` header to perform an | ||
| operations. |
| - [Bug Fields](api/core/v1/field.md) | ||
| - [Flag Activity](api/core/v1/flag-activity.md) | ||
| - [General](api/core/v1/general.md) | ||
| - [Github](api/core/v1/github.md) |
| - [Bug Fields](field.md) | ||
| - [Flag Activity](flag-activity.md) | ||
| - [General](general.md) | ||
| - [Github](github.md) |
…tter performance from search
…ng pull request data to cut down on rate limiting
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.