Skip to content

Commit

Permalink
misc
Browse files Browse the repository at this point in the history
  • Loading branch information
gmaze committed Jun 28, 2024
1 parent 145a2c9 commit d45abd1
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 2 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_edit_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Suggest Documentation change
about: 'Suggest a documentation change'
title: ''
labels: 'doc-edit'
assignees: ''

---

<!-- A short summary of the proposed documentation change -->


#### Section to be changed

#### Expected Output


#### Problem Description
<!-- this should explain why the current behavior is a problem and why the expected output is a better solution -->


#### Versions

<details><summary>Output of `argopy.show_versions()`</summary>

<!-- Paste the output here argopy.show_versions() here -->


</details>
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ repository:
html:
use_repository_button: true
use_issues_button: true
use_edit_page_button: true
announcement: "⚠️ This is a template website ! ⚠️"
use_edit_page_button: false
announcement: "⚠️ This is a template website ⚠️"
extra_footer: |
<p> By the Euro-Argo Dev community using
<a href="https://jupyterbook.org/intro.html" target="_blank">Jupyter Book</a>.
Expand Down
11 changes: 11 additions & 0 deletions sections/section4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
(section-4)=
# Contributing to the documentation

## Suggest modification

The easiest method to suggest modifications to the documentation maintainers is to click the "Open issues" button at the top of the page to be modified.


This should take users to the documentation hosting repository where one of the templates can used:
- "Suggest Documentation change",
- "Report an error on the documentation"

0 comments on commit d45abd1

Please sign in to comment.