diff --git a/src/pulp_docs/navigation.py b/src/pulp_docs/navigation.py index bebc2fc..4dad37e 100644 --- a/src/pulp_docs/navigation.py +++ b/src/pulp_docs/navigation.py @@ -125,12 +125,9 @@ def grouped_by_persona(tmpdir: Path, repos: Repos): {"Extras": f.repo_grouping("{repo}/docs/dev/{content}", repo_types=["other"])}, ] help_section = [ - *f.get_children("pulp-docs/docs/sections/help/community"), - { - "Documentation Usage": f.get_children( - "pulp-docs/docs/sections/help/using-this-doc" - ) - }, + {"Overview": f.section_file("help/index.md")}, + {"Community": f.get_children("pulp-docs/docs/sections/help/community")}, + {"More": f.get_children("pulp-docs/docs/sections/help/more")}, { "Changelogs": [ {"Pulpcore": "pulpcore/changes/changelog.md"}, @@ -148,7 +145,6 @@ def grouped_by_persona(tmpdir: Path, repos: Repos): }, ] }, - {"Governance": f.get_children("pulp-docs/docs/sections/help/governance")}, ] # Main Section diff --git a/staging_docs/sections/admin/index.md b/staging_docs/sections/admin/index.md index 7e45715..8fa1435 100644 --- a/staging_docs/sections/admin/index.md +++ b/staging_docs/sections/admin/index.md @@ -30,22 +30,3 @@ Common needs are to *configure, deploy and maintain Pulp instances*. ---- - -## Quick Links - - -{% for repo_type in ("core", "content") %} -Repo | Version | Rest API | Github Page | Changelog ---- | --- | --- | --- | --- -{% for repo in get_repos(repo_type) -%} -{{ repo.title }} | `{{ repo.version }}` | :link: | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }}) -{% endfor %} -{% endfor %} - -Repo | Version | Code (Github) | Changelog ---- | --- | --- | --- -{% for repo in get_repos("other") -%} -{{ repo.title }} | `{{ repo.version }}` | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }}) -{% endfor %} - diff --git a/staging_docs/sections/dev/index.md b/staging_docs/sections/dev/index.md index 608b29e..052a74c 100644 --- a/staging_docs/sections/dev/index.md +++ b/staging_docs/sections/dev/index.md @@ -32,22 +32,3 @@ Common needs are to *improve docs, fix bugs and add features*. ---- - -## Quick Links - - -{% for repo_type in ("core", "content") %} -Repo | Version | Rest API | Github Page | Changelog ---- | --- | --- | --- | --- -{% for repo in get_repos(repo_type) -%} -{{ repo.title }} | `{{ repo.version }}` | :link: | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }}) -{% endfor %} -{% endfor %} - -Repo | Version | Code (Github) | Changelog ---- | --- | --- | --- -{% for repo in get_repos("other") -%} -{{ repo.title }} | `{{ repo.version }}` | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }}) -{% endfor %} - diff --git a/staging_docs/sections/help/governance/code-of-conduct.md b/staging_docs/sections/help/code-of-conduct.md similarity index 100% rename from staging_docs/sections/help/governance/code-of-conduct.md rename to staging_docs/sections/help/code-of-conduct.md diff --git a/staging_docs/sections/help/index.md b/staging_docs/sections/help/index.md new file mode 100644 index 0000000..bf7430c --- /dev/null +++ b/staging_docs/sections/help/index.md @@ -0,0 +1,28 @@ +# Overview + +:wave: Welcome to the help section! + +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/). +Understaning the docs will help you find what you need more quickly. + +For some human help, you should visit the [Get Involved](site:pulp-docs/docs/sections/help/community/00_get-involved/) section. +There you'll learn about how to can reach out to the Pulp Community. +Don't hesistate to contact us! + +--- + +## Quick Links + +{% for repo_type in ("core", "content") %} +Repo | Version | Rest API | Github Page | Changelog +--- | --- | --- | --- | --- +{% for repo in get_repos(repo_type) -%} +{{ repo.title }} | `{{ repo.version }}` | :link: | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }}) +{% endfor %} +{% endfor %} + +Repo | Version | Code (Github) | Changelog +--- | --- | --- | --- +{% for repo in get_repos("other") -%} +{{ repo.title }} | `{{ repo.version }}` | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }}) +{% endfor %} diff --git a/staging_docs/sections/help/more/docs-usage.md b/staging_docs/sections/help/more/docs-usage.md new file mode 100644 index 0000000..2a368e4 --- /dev/null +++ b/staging_docs/sections/help/more/docs-usage.md @@ -0,0 +1,3 @@ +# Documentation Usage + +EDITME diff --git a/staging_docs/sections/help/more/governance/code-of-conduct.md b/staging_docs/sections/help/more/governance/code-of-conduct.md new file mode 100644 index 0000000..1062794 --- /dev/null +++ b/staging_docs/sections/help/more/governance/code-of-conduct.md @@ -0,0 +1,75 @@ +# Code of Conduct + +## Contributor Covenant Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +education, socio-economic status, nationality, personal appearance, race, +religion, or sexual identity and orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at pulp-conduct@redhat.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +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) + +[homepage]: https://www.contributor-covenant.org diff --git a/staging_docs/sections/help/governance/privacy.md b/staging_docs/sections/help/more/governance/privacy.md similarity index 100% rename from staging_docs/sections/help/governance/privacy.md rename to staging_docs/sections/help/more/governance/privacy.md diff --git a/staging_docs/sections/help/using-this-doc/00-background.md b/staging_docs/sections/help/using-this-doc/00-background.md deleted file mode 100644 index 2f16e10..0000000 --- a/staging_docs/sections/help/using-this-doc/00-background.md +++ /dev/null @@ -1,5 +0,0 @@ -# Background Knowledge - -About Diataxis background, pulp repository types and pulp personas. - -EDITME diff --git a/staging_docs/sections/help/using-this-doc/01-doc-anatomy.md b/staging_docs/sections/help/using-this-doc/01-doc-anatomy.md deleted file mode 100644 index 72944f4..0000000 --- a/staging_docs/sections/help/using-this-doc/01-doc-anatomy.md +++ /dev/null @@ -1,3 +0,0 @@ -# The Anatomy of the Website - -EDITME diff --git a/staging_docs/sections/help/using-this-doc/02-nav-and-search.md b/staging_docs/sections/help/using-this-doc/02-nav-and-search.md deleted file mode 100644 index e4d4227..0000000 --- a/staging_docs/sections/help/using-this-doc/02-nav-and-search.md +++ /dev/null @@ -1,3 +0,0 @@ -# Navigation and Search Tips - -EDITME diff --git a/staging_docs/sections/user/index.md b/staging_docs/sections/user/index.md index 302573e..e3ebd89 100644 --- a/staging_docs/sections/user/index.md +++ b/staging_docs/sections/user/index.md @@ -32,22 +32,3 @@ Common needs are to *create, sync, publish and interact with repositories*. ---- - -## Quick Links - - -{% for repo_type in ("core", "content") %} -Repo | Version | Rest API | Github Page | Changelog ---- | --- | --- | --- | --- -{% for repo in get_repos(repo_type) -%} -{{ repo.title }} | `{{ repo.version }}` | :link: | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }}) -{% endfor %} -{% endfor %} - -Repo | Version | Code (Github) | Changelog ---- | --- | --- | --- -{% for repo in get_repos("other") -%} -{{ repo.title }} | `{{ repo.version }}` | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }}) -{% endfor %} -