diff --git a/README.md b/README.md index f76e8ce41..30e259360 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,16 @@ The community is writing guides, installation instructions, and everything you n - [Issue Tracker](https://github.com/plone/documentation/issues) - [Source Code](https://github.com/plone/documentation/tree/6-dev) +### Contributing to frontend (Volto), `plone.api`, and `plone.restapi` documentation + +Plone documentation consists of this repository, `plone/documentation`, and it includes external packages' documentation through git submodules. +Those packages include: + +- [`volto`](https://github.com/plone/volto) +- [`plone.api`](https://github.com/plone/plone.api) +- [`plone.restapi`(https://github.com/plone/plone.restapi) +To contribute documentation, please open a pull request in the appropriate repository. +For details, see [Editing external package documentation](https://6.dev-docs.plone.org/contributing/index.html#contributing-editing-external-package-documentation-label). ## Support diff --git a/docs/conf.py b/docs/conf.py index 332c0a086..38db28db1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,7 +62,7 @@ # to convert quotes and dashes to typographically correct entities. # Note to maintainers: setting this to `True` will cause contractions and # hyphenated words to be marked as misspelled by spellchecker. -smartquotes=False +smartquotes = False # The name of the Pygments (syntax highlighting) style to use. # pygments_style = "sphinx.pygments_styles.PyramidStyle" @@ -136,12 +136,12 @@ # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html myst_enable_extensions = [ "deflist", # You will be able to utilise definition lists - # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists + # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists "linkify", # Identify “bare” web URLs and add hyperlinks. "colon_fence", # You can also use ::: delimiters to denote code fences,\ - # instead of ```. + # instead of ```. "substitution", # plone.restapi \ - # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2 + # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2 ] myst_substitutions = { @@ -208,8 +208,7 @@ html_logo = "_static/logo.svg" html_favicon = "_static/favicon.ico" -html_css_files = ["custom.css", - ("print.css", {"media": "print"})] +html_css_files = ["custom.css", ("print.css", {"media": "print"})] # See http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos todo_include_todos = True @@ -258,10 +257,22 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]) latex_documents = [ - ("index", "PloneDocumentation.tex", "Plone Documentation", - "The Plone community", "manual"), + ( + "index", + "PloneDocumentation.tex", + "Plone Documentation", + "The Plone community", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of # the title page. latex_logo = "_static/logo_2x.png" + + +# suggest edit link +# remark: {{ file_name }} is mandatory in "edit_page_url_template" +html_context = { + "edit_page_url_template": "https://6.dev-docs.plone.org/contributing/index.html?{{ file_name }}#making-contributions-on-github", +} diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 2726f19dc..4d313004e 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -84,7 +84,7 @@ Tap, click, or hover over the GitHub Octocat icon for options. :alt: GitHub navigation menu ``` -You can use this menu to quickly navigate to the `documentation` source repository, open an issue, or suggest an edit to the current document. +You can use this menu to quickly navigate to the `documentation` source repository or open an issue. Note that this navigation convenience is provided only for the `documentation` repository.