Skip to content

Commit ea879d1

Browse files
committed
Improve Help section and clean section overviews
[noissue]
1 parent e7fadf8 commit ea879d1

File tree

12 files changed

+109
-75
lines changed

12 files changed

+109
-75
lines changed

src/pulp_docs/navigation.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -125,12 +125,9 @@ def grouped_by_persona(tmpdir: Path, repos: Repos):
125125
{"Extras": f.repo_grouping("{repo}/docs/dev/{content}", repo_types=["other"])},
126126
]
127127
help_section = [
128-
*f.get_children("pulp-docs/docs/sections/help/community"),
129-
{
130-
"Documentation Usage": f.get_children(
131-
"pulp-docs/docs/sections/help/using-this-doc"
132-
)
133-
},
128+
{"Overview": f.section_file("help/index.md")},
129+
{"Community": f.get_children("pulp-docs/docs/sections/help/community")},
130+
{"More": f.get_children("pulp-docs/docs/sections/help/more")},
134131
{
135132
"Changelogs": [
136133
{"Pulpcore": "pulpcore/changes/changelog.md"},
@@ -148,7 +145,6 @@ def grouped_by_persona(tmpdir: Path, repos: Repos):
148145
},
149146
]
150147
},
151-
{"Governance": f.get_children("pulp-docs/docs/sections/help/governance")},
152148
]
153149

154150
# Main Section

staging_docs/sections/admin/index.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,3 @@ Common needs are to *configure, deploy and maintain Pulp instances*.
3030
</div>
3131
</div>
3232

33-
---
34-
35-
## Quick Links
36-
37-
38-
{% for repo_type in ("core", "content") %}
39-
Repo | Version | Rest API | Github Page | Changelog
40-
--- | --- | --- | --- | ---
41-
{% for repo in get_repos(repo_type) -%}
42-
{{ repo.title }} | `{{ repo.version }}` | <a href="{{ repo.rest_api_url}}" target="_blank">:link:</a> | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }})
43-
{% endfor %}
44-
{% endfor %}
45-
46-
Repo | Version | Code (Github) | Changelog
47-
--- | --- | --- | ---
48-
{% for repo in get_repos("other") -%}
49-
{{ repo.title }} | `{{ repo.version }}` | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }})
50-
{% endfor %}
51-

staging_docs/sections/dev/index.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,22 +32,3 @@ Common needs are to *improve docs, fix bugs and add features*.
3232
</div>
3333
</div>
3434

35-
---
36-
37-
## Quick Links
38-
39-
40-
{% for repo_type in ("core", "content") %}
41-
Repo | Version | Rest API | Github Page | Changelog
42-
--- | --- | --- | --- | ---
43-
{% for repo in get_repos(repo_type) -%}
44-
{{ repo.title }} | `{{ repo.version }}` | <a href="{{ repo.rest_api_url}}" target="_blank">:link:</a> | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }})
45-
{% endfor %}
46-
{% endfor %}
47-
48-
Repo | Version | Code (Github) | Changelog
49-
--- | --- | --- | ---
50-
{% for repo in get_repos("other") -%}
51-
{{ repo.title }} | `{{ repo.version }}` | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }})
52-
{% endfor %}
53-
File renamed without changes.

staging_docs/sections/help/index.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Overview
2+
3+
:wave: Welcome to the help section!
4+
5+
If this is the first time navigating trough these docs, we recommend reading the [Documentation Usage](site:pulp-docs/docs/sections/help/more/docs-usage/).
6+
Understaning the docs will help you find what you need more quickly.
7+
8+
For some human help, you should visit the [Get Involved](site:pulp-docs/docs/sections/help/community/00_get-involved/) section.
9+
There you'll learn about how to can reach out to the Pulp Community.
10+
Don't hesistate to contact us!
11+
12+
---
13+
14+
## Quick Links
15+
16+
{% for repo_type in ("core", "content") %}
17+
Repo | Version | Rest API | Github Page | Changelog
18+
--- | --- | --- | --- | ---
19+
{% for repo in get_repos(repo_type) -%}
20+
{{ repo.title }} | `{{ repo.version }}` | <a href="{{ repo.rest_api_url}}" target="_blank">:link:</a> | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }})
21+
{% endfor %}
22+
{% endfor %}
23+
24+
Repo | Version | Code (Github) | Changelog
25+
--- | --- | --- | ---
26+
{% for repo in get_repos("other") -%}
27+
{{ repo.title }} | `{{ repo.version }}` | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }})
28+
{% endfor %}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Documentation Usage
2+
3+
EDITME
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Code of Conduct
2+
3+
## Contributor Covenant Code of Conduct
4+
5+
### Our Pledge
6+
7+
In the interest of fostering an open and welcoming environment, we as
8+
contributors and maintainers pledge to making participation in our project and
9+
our community a harassment-free experience for everyone, regardless of age, body
10+
size, disability, ethnicity, gender identity and expression, level of experience,
11+
education, socio-economic status, nationality, personal appearance, race,
12+
religion, or sexual identity and orientation.
13+
14+
### Our Standards
15+
16+
Examples of behavior that contributes to creating a positive environment
17+
include:
18+
19+
* Using welcoming and inclusive language
20+
* Being respectful of differing viewpoints and experiences
21+
* Gracefully accepting constructive criticism
22+
* Focusing on what is best for the community
23+
* Showing empathy towards other community members
24+
25+
Examples of unacceptable behavior by participants include:
26+
27+
* The use of sexualized language or imagery and unwelcome sexual attention or
28+
advances
29+
* Trolling, insulting/derogatory comments, and personal or political attacks
30+
* Public or private harassment
31+
* Publishing others' private information, such as a physical or electronic
32+
address, without explicit permission
33+
* Other conduct which could reasonably be considered inappropriate in a
34+
professional setting
35+
36+
### Our Responsibilities
37+
38+
Project maintainers are responsible for clarifying the standards of acceptable
39+
behavior and are expected to take appropriate and fair corrective action in
40+
response to any instances of unacceptable behavior.
41+
42+
Project maintainers have the right and responsibility to remove, edit, or
43+
reject comments, commits, code, wiki edits, issues, and other contributions
44+
that are not aligned to this Code of Conduct, or to ban temporarily or
45+
permanently any contributor for other behaviors that they deem inappropriate,
46+
threatening, offensive, or harmful.
47+
48+
### Scope
49+
50+
This Code of Conduct applies both within project spaces and in public spaces
51+
when an individual is representing the project or its community. Examples of
52+
representing a project or community include using an official project e-mail
53+
address, posting via an official social media account, or acting as an appointed
54+
representative at an online or offline event. Representation of a project may be
55+
further defined and clarified by project maintainers.
56+
57+
### Enforcement
58+
59+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
60+
reported by contacting the project team at [email protected]. All
61+
complaints will be reviewed and investigated and will result in a response that
62+
is deemed necessary and appropriate to the circumstances. The project team is
63+
obligated to maintain confidentiality with regard to the reporter of an incident.
64+
Further details of specific enforcement policies may be posted separately.
65+
66+
Project maintainers who do not follow or enforce the Code of Conduct in good
67+
faith may face temporary or permanent repercussions as determined by other
68+
members of the project's leadership.
69+
70+
### Attribution
71+
72+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
73+
available at [`https://www.contributor-covenant.org/version/1/4/code-of-conduct.html`](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
74+
75+
[homepage]: https://www.contributor-covenant.org
File renamed without changes.

staging_docs/sections/help/using-this-doc/00-background.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

staging_docs/sections/help/using-this-doc/01-doc-anatomy.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)