Skip to content

Commit 89f8730

Browse files
authored
Merge pull request plone#1292 from plone/fix-dropdown-menu-new-issue-,-etc
Fix dropdown menu new issue , etc
2 parents c6aff7e + df927e2 commit 89f8730

File tree

3 files changed

+30
-9
lines changed

3 files changed

+30
-9
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ The community is writing guides, installation instructions, and everything you n
3131
- [Issue Tracker](https://github.com/plone/documentation/issues)
3232
- [Source Code](https://github.com/plone/documentation/tree/6-dev)
3333

34+
### Contributing to frontend (Volto), `plone.api`, and `plone.restapi` documentation
35+
36+
Plone documentation consists of this repository, `plone/documentation`, and it includes external packages' documentation through git submodules.
37+
Those packages include:
38+
39+
- [`volto`](https://github.com/plone/volto)
40+
- [`plone.api`](https://github.com/plone/plone.api)
41+
- [`plone.restapi`(https://github.com/plone/plone.restapi)
42+
To contribute documentation, please open a pull request in the appropriate repository.
43+
For details, see [Editing external package documentation](https://6.dev-docs.plone.org/contributing/index.html#contributing-editing-external-package-documentation-label).
3444

3545
## Support
3646

docs/conf.py

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
# to convert quotes and dashes to typographically correct entities.
6363
# Note to maintainers: setting this to `True` will cause contractions and
6464
# hyphenated words to be marked as misspelled by spellchecker.
65-
smartquotes=False
65+
smartquotes = False
6666

6767
# The name of the Pygments (syntax highlighting) style to use.
6868
# pygments_style = "sphinx.pygments_styles.PyramidStyle"
@@ -136,12 +136,12 @@
136136
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
137137
myst_enable_extensions = [
138138
"deflist", # You will be able to utilise definition lists
139-
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
139+
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
140140
"linkify", # Identify “bare” web URLs and add hyperlinks.
141141
"colon_fence", # You can also use ::: delimiters to denote code fences,\
142-
# instead of ```.
142+
# instead of ```.
143143
"substitution", # plone.restapi \
144-
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
144+
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
145145
]
146146

147147
myst_substitutions = {
@@ -208,8 +208,7 @@
208208
html_logo = "_static/logo.svg"
209209
html_favicon = "_static/favicon.ico"
210210

211-
html_css_files = ["custom.css",
212-
("print.css", {"media": "print"})]
211+
html_css_files = ["custom.css", ("print.css", {"media": "print"})]
213212

214213
# See http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos
215214
todo_include_todos = True
@@ -258,10 +257,22 @@
258257
# Grouping the document tree into LaTeX files. List of tuples
259258
# (source start file, target name, title, author, documentclass [howto/manual])
260259
latex_documents = [
261-
("index", "PloneDocumentation.tex", "Plone Documentation",
262-
"The Plone community", "manual"),
260+
(
261+
"index",
262+
"PloneDocumentation.tex",
263+
"Plone Documentation",
264+
"The Plone community",
265+
"manual",
266+
),
263267
]
264268

265269
# The name of an image file (relative to this directory) to place at the top of
266270
# the title page.
267271
latex_logo = "_static/logo_2x.png"
272+
273+
274+
# suggest edit link
275+
# remark: {{ file_name }} is mandatory in "edit_page_url_template"
276+
html_context = {
277+
"edit_page_url_template": "https://6.dev-docs.plone.org/contributing/index.html?{{ file_name }}#making-contributions-on-github",
278+
}

docs/contributing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Tap, click, or hover over the GitHub Octocat icon for options.
8484
:alt: GitHub navigation menu
8585
```
8686

87-
You can use this menu to quickly navigate to the `documentation` source repository, open an issue, or suggest an edit to the current document.
87+
You can use this menu to quickly navigate to the `documentation` source repository or open an issue.
8888
Note that this navigation convenience is provided only for the `documentation` repository.
8989

9090

0 commit comments

Comments
 (0)