Skip to content

Commit 05d255b

Browse files
osamajandaliosamajandali
committed
Use GSF doc template
1 parent d225a2c commit 05d255b

File tree

146 files changed

+8737
-17825
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+8737
-17825
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature-request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/meeting-template.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Meeting Template
3+
about: To track principles project meeting agenda, minutes and attendance
4+
title: YYYY MM DD - Green Software Principles Agenda
5+
labels: Meeting
6+
assignees: ''
7+
8+
---
9+
10+
## Date
11+
YYYY-MM-DD - 3pm UTC - See the time in your timezone https://everytimezone.com/s/a8399b00
12+
13+
## Meeting notices
14+
15+
### Antitrust Policy
16+
Linux Foundation meetings involve participation by industry competitors, and it is the intention of the Linux Foundation to conduct all of its activities in accordance with applicable antitrust and competition laws. It is therefore extremely important that attendees adhere to meeting agendas, and be aware of, and not participate in, any activities that are prohibited under applicable US state, federal or foreign antitrust and competition laws.
17+
18+
Examples of types of actions that are prohibited at Linux Foundation meetings and in connection with Linux Foundation activities are described in the Linux Foundation Antitrust Policy available at http://www.linuxfoundation.org/antitrust-policy. If you have questions about these matters, please contact your company counsel, or if you are a member of the Linux Foundation, feel free to contact Andrew Updegrove of the firm of Gesmer Updegrove LLP, which provides legal counsel to the Linux Foundation.
19+
20+
### Recordings
21+
GSF project meetings may be recorded for use solely by the GSF team for administration purposes. In very limited instances, and with explicit approval, recordings may be made more widely available.
22+
23+
### Roll Call
24+
Please *add a comment* to this issue during the meeting to denote attendance.
25+
26+
Any untracked attendees will be added by the GSF team below:
27+
- Full Name, Affiliation, (optional) GitHub username
28+
29+
## Agenda
30+
- [ ] Convene & Roll Call (5mins)
31+
- [ ] Review Meeting Notices (see above)
32+
- [ ] Approve Past Meeting Minutes
33+
- [ ] Review Pull Requests
34+
- [ ] Review Pull Request XXXX
35+
- [ ] Discuss Issues
36+
- [ ] Discuss Issue XXXXX
37+
- [ ] Agenda item 1
38+
- [ ] Agenda item 2
39+
- [ ] ...
40+
- [ ] AOB, Q&A & Adjourn (5mins)
41+
42+
## Action Items
43+
- [ ] Action 1
44+
- [ ] Action 2
45+
- [ ] ...

‎.github/workflows/deploy-main.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
jobs:
11+
deploy:
12+
name: Deploy to GitHub Pages
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
- uses: actions/setup-node@v3
17+
with:
18+
node-version: 18
19+
cache: yarn
20+
21+
- name: Install dependencies
22+
run: yarn install --frozen-lockfile
23+
- name: Build website
24+
run: yarn build
25+
26+
# Popular action to deploy to GitHub Pages:
27+
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
28+
- name: Deploy to GitHub Pages
29+
uses: peaceiris/actions-gh-pages@v3
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
# Build output to publish to the `gh-pages` branch:
33+
publish_dir: ./build
34+
# The following lines assign commit authorship to the official
35+
# GH-Actions bot for deploys to `gh-pages` branch:
36+
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
37+
# The GH actions bot is used by default if you didn't specify the two fields.
38+
# You can swap them out with your own user credentials.
39+
user_name: github-actions[bot]
40+
user_email: 41898282+github-actions[bot]@users.noreply.github.com

‎.gitignore

+20-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
node_modules
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎CODE-OF-CONDUCT.md

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be directly
62+
reported to the Executive Director of the Green Software Foundation at [email protected] or any community leaders responsible for enforcement.
63+
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][faq]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
130+
[mozilla coc]: https://github.com/mozilla/diversity
131+
[faq]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations
133+
134+
---

‎CONFIGURE.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Configuring this repository
2+
3+
This is a template repository based on docusaurus.io
4+
5+
## Update these files
6+
7+
### docusaurus.config.js
8+
9+
This configuration file defines many of the top level features of the website such as the menu, title etc...
10+
11+
Replace all references to `TODO` and `PROJECT-TITLE` with the appropriate content for your website.
12+
13+
### README.md
14+
15+
- Replace the `PROJECT-TITLE` with your projects title.
16+
- Replace the `TODO's` with your content, including the main title.
17+
- Ensure it refers to the right working group and URL.
18+
- Ensure it refers to the right license.
19+
20+
### docs/index.mdx
21+
22+
This is the landing page of the website.
23+
24+
- Replace the `PROJECT-TITLE` with your projects title.
25+
- Replace the `TODO's` with your content, including the main title.
26+
- Add the right people to the Team section.
27+
- Every team member must have a GitHub profile.
28+
- The `<TeamMember>` component will source an image for each person from their GitHub profile.
29+
- Every project index page must have:
30+
- A Summary
31+
- Links including the PR-FAQ
32+
- A getting started section for people new to the project
33+
- How the project communicates e.g. the main email address of the project).
34+
- Information regarding the core team.
35+
36+
### CONTRIBUTING.md
37+
38+
Double check that the content in this file is still applicable for your project and workflow.
39+
40+
### LICENSE
41+
42+
The license file is MIT, double check this is valid for you (MIT is the default license for the GSF except in some rare situations)
43+
44+
### .github/workflows/deploy-main.yml
45+
46+
- This is the GitHub Action that builds the website of this repository and deploys it.
47+
- This yml uses GitHub pages to deploy the project based off the contents of the `main` branch.
48+
- Every time there is a change made to the `main` branch this action is re-run and the website rebuilt.
49+
50+
If you are happy with this approach, nothing needs to be changed here.
51+
52+
### .github/ISSUE_TEMPLATE/meeting-template.md
53+
54+
This is a GitHub issue template for meeting agendas.
55+
56+
In this template you can define some default agenda items or other content which will appear in each meeting agenda, edit as you wish.
57+
58+
### static/CNAME
59+
60+
If you are using GitHub pages to deploy (the default) and you want to use a custom domain like `myproject.greensoftware.foundation` then you need to add **JUST** the text `myproject.greensoftware.foundation` to this file.
61+
62+
### Delete this CONFIGURE.md
63+
64+
Once you are happy with the setup please delete this file.
65+
66+
## Settings
67+
68+
### Deploying a website
69+
70+
The default platform we use for deploying websites is GitHub pages. You will need to add certain settings to your `/settings/pages` section of your repository to enable this.
71+
72+
### Custom Domain Names
73+
74+
Ask the GSF Ops team to create a `CNAME` record for the subdomain you want your project to live under greensoftware.foundation, e.g. for myproject.greensoftware.foundation they will need to create a `CNAME` record pointing `myproject` to `green-software-foundation.github.io`

0 commit comments

Comments
 (0)