Skip to content

Bug 2067852 - Migrate rst docs to markdown and host inside of bugzilla itself - #2731

Open
dklawren wants to merge 13 commits into
mozilla:masterfrom
dklawren:2067852
Open

Bug 2067852 - Migrate rst docs to markdown and host inside of bugzilla itself#2731
dklawren wants to merge 13 commits into
mozilla:masterfrom
dklawren:2067852

Conversation

@dklawren

Copy link
Copy Markdown
Collaborator

No description provided.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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
FileDescription
template/en/default/search/form.html.tmplUpdates relative-date documentation link.
template/en/default/pages/doc_viewer.html.tmplAdds the documentation viewer template.
template/en/default/global/user-error.html.tmplAdds a documentation 404 page.
template/en/default/global/header.html.tmplAlways displays the documentation menu item.
template/en/default/global/docslinks.html.tmplAlways renders available documentation links.
template/en/default/bug/tagging.html.tmplUpdates tag documentation link.
template/en/default/admin/params/general.html.tmplRemoves docs_urlbase configuration help.
template/en/default/account/prefs/mfa.html.tmplUpdates MFA documentation link.
template/en/default/account/prefs/apikey.html.tmplMoves authentication help in-app.
t/Support/Files.pmRemoves the deleted documentation builder.
t/mojo-docs.tTests in-app documentation routing and rendering.
skins/standard/docs.cssStyles rendered Markdown documentation.
Makefile.PLRemoves the documentation build feature.
js/util.jsUpdates REST API documentation URL.
extensions/BugModal/web/attachments_overlay.jsUpdates attachment API documentation URL.
docs/style.cssRemoves generated POD documentation styling.
docs/makedocs.plRemoves the Sphinx/POD build script.
docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pmRemoves POD batch-rendering support.
docs/lib/Pod/Simple/HTML/Bugzilla.pmRemoves POD HTML rendering support.
docs/en/rst/using/tips.rstRemoves the reStructuredText source.
docs/en/rst/using/reports-and-charts.rstRemoves the reStructuredText source.
docs/en/rst/using/preferences.rstRemoves the reStructuredText source.
docs/en/rst/using/index.rstRemoves the reStructuredText source.
docs/en/rst/using/filing.rstRemoves the reStructuredText source.
docs/en/rst/using/extensions.rstRemoves the reStructuredText source.
docs/en/rst/using/editing.rstRemoves the reStructuredText source.
docs/en/rst/using/creating-an-account.rstRemoves the reStructuredText source.
docs/en/rst/style.rstRemoves the reStructuredText style guide.
docs/en/rst/requirements.txtRemoves Sphinx dependencies.
docs/en/rst/integrating/skins.rstRemoves the reStructuredText source.
docs/en/rst/integrating/languages.rstRemoves the reStructuredText source.
docs/en/rst/integrating/index.rstRemoves the reStructuredText source.
docs/en/rst/integrating/faq.rstRemoves the reStructuredText source.
docs/en/rst/integrating/extensions.rstRemoves the reStructuredText source.
docs/en/rst/integrating/auth0.rstRemoves the reStructuredText source.
docs/en/rst/integrating/apis.rstRemoves the reStructuredText source.
docs/en/rst/index.rstRemoves the Sphinx documentation index.
docs/en/rst/extensions/Webhooks/api/v1/webhooks.rstRemoves the reStructuredText source.
docs/en/rst/extensions/Webhooks/api/v1/index.rstRemoves the reStructuredText source.
docs/en/rst/api/integration.rstRemoves the reStructuredText source.
docs/en/rst/api/index.rstRemoves the reStructuredText source.
docs/en/rst/api/core/v1/reminders.rstRemoves the reStructuredText source.
docs/en/rst/api/core/v1/index.rstRemoves the reStructuredText source.
docs/en/rst/api/core/v1/general.rstRemoves the reStructuredText source.
docs/en/rst/api/core/v1/flag-activity.rstRemoves the reStructuredText source.
docs/en/rst/api/core/v1/component.rstRemoves the reStructuredText source.
docs/en/rst/api/core/v1/classification.rstRemoves the reStructuredText source.
docs/en/rst/api/core/v1/bugzilla.rstRemoves the reStructuredText source.
docs/en/rst/api/core/v1/bug-user-last-visit.rstRemoves the reStructuredText source.
docs/en/rst/administering/workflow.rstRemoves the reStructuredText source.
docs/en/rst/administering/whining.rstRemoves the reStructuredText source.
docs/en/rst/administering/quips.rstRemoves the reStructuredText source.
docs/en/rst/administering/preferences.rstRemoves the reStructuredText source.
docs/en/rst/administering/keywords.rstRemoves the reStructuredText source.
docs/en/rst/administering/index.rstRemoves the reStructuredText source.
docs/en/rst/administering/groups.rstRemoves the reStructuredText source.
docs/en/rst/administering/flags.rstRemoves the reStructuredText source.
docs/en/rst/administering/field-values.rstRemoves the reStructuredText source.
docs/en/rst/administering/extensions.rstRemoves the reStructuredText source.
docs/en/rst/administering/custom-fields.rstRemoves the reStructuredText source.
docs/en/rst/about/index.rstRemoves the reStructuredText source.
docs/en/rst/_static/bugzilla.cssRemoves Sphinx-specific styling.
docs/en/md/using/tips.mdAdds Markdown user tips.
docs/en/md/using/reports-and-charts.mdAdds Markdown reporting documentation.
docs/en/md/using/preferences.mdAdds Markdown preference documentation.
docs/en/md/using/index.mdAdds the Markdown user-guide index.
docs/en/md/using/filing.mdAdds Markdown bug-filing guidance.
docs/en/md/using/extensions.mdAdds extension documentation links.
docs/en/md/using/editing.mdAdds Markdown bug-editing guidance.
docs/en/md/using/creating-an-account.mdAdds account-creation guidance.
docs/en/md/style.mdAdds the Markdown documentation style guide.
docs/en/md/integrating/skins.mdAdds skin customization guidance.
docs/en/md/integrating/languages.mdAdds localization guidance.
docs/en/md/integrating/index.mdAdds the integration-guide index.
docs/en/md/integrating/faq.mdAdds the customization FAQ.
docs/en/md/integrating/extensions.mdAdds extension-development guidance.
docs/en/md/integrating/auth0.mdAdds Auth0 integration guidance.
docs/en/md/integrating/apis.mdAdds API selection guidance.
docs/en/md/index.mdAdds the main Markdown documentation index.
docs/en/md/extensions/Webhooks/api/v1/webhooks.mdAdds Webhooks API documentation.
docs/en/md/extensions/Webhooks/api/v1/index.mdAdds the Webhooks API index.
docs/en/md/api/integration.mdAdds integration best practices.
docs/en/md/api/index.mdAdds the API reference index.
docs/en/md/api/core/v1/reminders.mdAdds reminder API documentation.
docs/en/md/api/core/v1/index.mdAdds the core API index.
docs/en/md/api/core/v1/flag-activity.mdAdds flag-activity API documentation.
docs/en/md/api/core/v1/component.mdAdds component API documentation.
docs/en/md/api/core/v1/classification.mdAdds classification API documentation.
docs/en/md/api/core/v1/bugzilla.mdAdds Bugzilla information API documentation.
docs/en/md/api/core/v1/bug-user-last-visit.mdAdds last-visit API documentation.
docs/en/md/administering/workflow.mdAdds workflow administration guidance.
docs/en/md/administering/whining.mdAdds scheduled-report guidance.
docs/en/md/administering/quips.mdAdds quip administration guidance.
docs/en/md/administering/preferences.mdAdds default-preference guidance.
docs/en/md/administering/keywords.mdAdds keyword administration guidance.
docs/en/md/administering/index.mdAdds the administration index.
docs/en/md/administering/flags.mdAdds flag administration guidance.
docs/en/md/administering/field-values.mdAdds field-value guidance.
docs/en/md/administering/extensions.mdAdds installed-extension guidance.
docs/en/md/administering/custom-fields.mdAdds custom-field guidance.
docs/en/md/about/index.mdAdds documentation metadata and credits.
docs/en/MakefileRemoves Sphinx build targets.
CONTRIBUTING.mdUpdates the README reference.
contribute.jsonPoints contributors to in-app documentation.
conf/checksetup_answers.txtRemoves the obsolete documentation URL setting.
conf/checksetup_answers_suite.txtRemoves the obsolete suite setting.
Bugzilla/WebService/Server/REST.pmUpdates REST error documentation URLs.
Bugzilla/Template/Plugin/Hook.pmUpdates extension documentation URL.
Bugzilla/Template.pmDefines the in-app documentation base URL.
Bugzilla/Markdown/GFM.pmAdds cmark rendering options.
Bugzilla/Install/Requirements.pmRemoves the documentation feature mapping.
Bugzilla/Install/Filesystem.pmRemoves generated-documentation permissions.
Bugzilla/Config/General.pmRemoves the docs_urlbase parameter.
Bugzilla/App/Plugin/Error.pmUpdates API error documentation URLs.
.vscode/settings.jsonRemoves Sphinx editor configuration.
.readthedocs.yamlRemoves 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.
Comment threaddocs/en/md/style.md
## 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 threadBugzilla/Template.pm
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.

![image](../../images/bzLifecycle.png)
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.
Comment threaddocs/en/md/index.md
- [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)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@dklawren@loganrosen