Skip to content

Commit

Permalink
chore: improve documentation for better rendering
Browse files Browse the repository at this point in the history
Adding additionally tools to verify build

Signed-off-by: Simon Schrottner <[email protected]>
  • Loading branch information
aepfli committed Mar 27, 2023
1 parent 2c939ba commit 23b78ba
Show file tree
Hide file tree
Showing 29 changed files with 357 additions and 285 deletions.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/community-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ assignees: ''

### References


### Sponsors

<!-- Mention Keptn maintainer sponsors here, if any -->
Expand Down
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/membership.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,20 @@ e.g. (at)example_user

### Membership level

Membership level according to https://github.com/keptn/community/blob/master/COMMUNITY_MEMBERSHIP.md
Membership level according to <https://github.com/keptn/community/blob/master/COMMUNITY_MEMBERSHIP.md>

member | approver | maintainer

### Requirements (for member)

- [ ] I have reviewed the community membership guidelines (https://github.com/keptn/community/blob/master/COMMUNITY_MEMBERSHIP.md)
- [ ] I have enabled 2FA on my GitHub account. See https://github.com/settings/security
- [ ] I have reviewed the community membership guidelines (<https://github.com/keptn/community/blob/master/COMMUNITY_MEMBERSHIP.md>)
- [ ] I have enabled 2FA on my GitHub account. See <https://github.com/settings/security>
- [ ] I have subscribed to the [Keptn Slack channel](http://slack.keptn.sh/)
- [ ] I am actively contributing to 1 or more Keptn subprojects
- [ ] I have two sponsors that meet the sponsor requirements listed in the community membership guidelines. Among other requirements, sponsors must be approvers or maintainers of at least one repository in the organization and not both affiliated with the same company
- [ ] I have spoken to 2 sponsors (approvers or maintainers) ahead of this application, and they have agreed to sponsor my application
- [ ] I have filed a PR to add myself as [project member](https://github.com/keptn/keptn/blob/master/MAINTAINERS) and referenced this issue in the PR

### Requirements (for approver, if applicable)

- [ ] I am a reviewer of the codebase for at least 1 month
Expand All @@ -49,7 +50,6 @@ member | approver | maintainer
- [ ] I have spoken to 2 sponsors (maintainers) ahead of this application, and they have agreed to sponsor my application
- [ ] I have filed a PR to add myself as [project maintainer](https://github.com/keptn/keptn/blob/master/MAINTAINERS) and referenced this issue in the PR


### Sponsors

<!-- Replace (at) with the `@` sign -->
Expand All @@ -64,4 +64,4 @@ Please remember, it is an applicant's responsibility to get their sponsors' conf

- PRs reviewed / authored
- Issues responded to
- SIG projects I am involved with
- SIG projects I am involved with
10 changes: 8 additions & 2 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,15 @@ CheckDoctype: false
IgnoreDirs:
- favicons
- readme
- mentorship
IgnoreURLs:
- "linkedin.com"
- "localhost"
- "canva.com"
StripQueryString: false
- "https://github.com/open-telemetry/community/blob"
- "https://raw.githubusercontent.com/iamrajiv"
- "https://summerofcode.withgoogle.com"
- "https://www.oaoa.com"
- "engineering.dynatrace.com"
- "media-exp1.licdn.com"
- "https://contrib.rocks"
- "https://github.com/eyskim"
15 changes: 15 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
config:
line-length: false
no-inline-html:
allowed_elements:
- details
- summary
github-admonition: true
max-one-sentence-per-line: true

ignores:
- "CHANGELOG.md"
- "node_modules"
- "tmp"
- "mentorship/gsoc/2022"
- "elections/2022"
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ 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
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
<https://www.contributor-covenant.org/faq>
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
[![GitHub Discussions](https://img.shields.io/github/discussions/keptn/keptn)](https://github.com/keptn/keptn/discussions)
[![Community Roadmap](https://img.shields.io/badge/Community-roadmap-yellow)](https://github.com/orgs/keptn/projects/1?card_filter_query=label%3Acommunity)

👋 Welcome to the Keptn community!
👋 Welcome to the Keptn community!
This repository is used for community management related issue tracking,
including but not limited to community programs, enhancement ideas, memberships and permissions.
including but not limited to community programs, enhancement ideas, memberships and permissions.
See also the community page on [**keptn.sh/community**](https://keptn.sh/community/).

## References
Expand Down Expand Up @@ -35,9 +35,9 @@ There are also some resources stored in this repository or elsewhere:
* [Community Roadmap](https://github.com/orgs/keptn/projects/1?card_filter_query=label%3Acommunity) - Major community initiatives
as a part of the Keptn roadmap.
* [Mentorship and Outreach programs](./mentorship/) -
programs we participate in.
programs we participate in.
* [Artwork](./branding/) - Keptn logos and artwork.
* [Keptn Project Infrastructure](./project-infrastructure/) -
* [Keptn Project Infrastructure](./project-infrastructure/) -
Documentation and notes regarding the project infrastructure being used by the project:
website, delivery infrastructure, repositories and services, etc.
* [Keptn incubation in the CNCF](./governance/cncf-incubation/) - Materials related to Keptn application for the incubation in the Cloud Native Computing Foundation.
Expand All @@ -49,8 +49,10 @@ See the [Keptn Contributing Guidelines](https://keptn.sh/community/contributing/

## Contributors

<!-- markdownlint-disable MD033-->
<a href="https://github.com/keptn/community/graphs/contributors">
<img src="https://contrib.rocks/image?repo=keptn/community" alt="Contributors"/>
</a>
<!-- markdownlint-enable MD033-->

Made with [contrib.rocks](https://contrib.rocks).
2 changes: 1 addition & 1 deletion branding/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Against dark backgrounds, use the white versions of the logo and the wordmark.

> Some of Keptn Open Graph Images are managed as Google Slides [here](https://docs.google.com/presentation/d/1VZu_PkqQldmlAJuGhZQOdFmBPvhG5AaZ9RV1GL6w3Vw/edit?usp=sharing).
> Feel free to reuse this content or suggest changes.
>
> For some other Open Graph Images, [Canva](https://www.canva.com/en_gb/) is used.
> If you would like to get access or get an image created,
> contact [Giulia Di Pietro](https://github.com/Giulia-dipietro) or [Oleg Nenashev](https://github.com/oleg-nenashev/).
Expand Down
Loading

0 comments on commit 23b78ba

Please sign in to comment.