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 ffbb0e2 commit 8984f31
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 21 deletions.
21 changes: 3 additions & 18 deletions .github/ISSUE_TEMPLATE/doc_edit_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,8 @@ assignees: ''

---

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

#### Section to be modified

#### 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>
<!-- Indicate here which section shall be modified -->
Binary file added images/screenshot_contributing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 8 additions & 3 deletions sections/section_contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@

## 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.
The easiest method to suggest modifications to the documentation maintainers is to click the "Open issue" button at the top of the page to be modified:

:::{figure-md} contributing
<img src="/images/screenshot_contributing.png">

This should take users to the documentation hosting repository where one of the templates can used:
- "Suggest Documentation change",
Click the Github>"Open Issue" icons to suggest a modification to a given page
:::

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

0 comments on commit 8984f31

Please sign in to comment.