Skip to content

Commit 3c6b7d9

Browse files
committed
Initial commit
1 parent 8428324 commit 3c6b7d9

File tree

311 files changed

+18681
-4
lines changed

Some content is hidden

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

311 files changed

+18681
-4
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 📚 Doc Enhancement
2+
description: Suggest an improvement or addition to existing documentation
3+
title: "[Doc-Enhancement]: "
4+
labels: ["doc enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to suggest an enhancement to our documentation!
10+
11+
- type: textarea
12+
id: enhancement-description
13+
attributes:
14+
label: Describe the enhancement
15+
description: A clear and concise description of what you want to improve or add.
16+
placeholder: "I think it would be better if..."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: enhancement-reason
22+
attributes:
23+
label: Reason for the enhancement
24+
description: Explain why this enhancement would be useful.
25+
placeholder: "This enhancement is important because..."
26+
validations:
27+
required: false
28+
29+
- type: textarea
30+
id: additional-context
31+
attributes:
32+
label: Additional Context
33+
description: Any additional information like links or screenshots.
34+
placeholder: "Additional details..."
35+
validations:
36+
required: false

.github/ISSUE_TEMPLATE/fix.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 🛠️ Fix
2+
description: Report errors, typos, or inconsistencies in the documentation
3+
title: "[Fix]: "
4+
labels: ["fix"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us improve our documentation by reporting a fix!
10+
11+
- type: textarea
12+
id: fix-description
13+
attributes:
14+
label: Describe the issue
15+
description: A clear and concise description of what the error or issue is.
16+
placeholder: "I found an issue where..."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: fix-location
22+
attributes:
23+
label: Location of the issue
24+
description: Please provide the location (e.g., URL, page number) of the issue in the documentation.
25+
placeholder: "The issue can be found in..."
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: suggested-correction
31+
attributes:
32+
label: Suggested Correction
33+
description: If possible, suggest how this issue should be corrected.
34+
placeholder: "I suggest changing it to..."
35+
validations:
36+
required: false
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 🆕 New Documentation
2+
description: Propose new documents or sections to be added
3+
title: "[New-Docs]: "
4+
labels: ["new docs"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting new documentation for our project!
10+
11+
- type: textarea
12+
id: document-title
13+
attributes:
14+
label: Title of the document or section
15+
description: A clear and concise title for the new document or section.
16+
placeholder: "Title"
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: document-description
22+
attributes:
23+
label: Description of the document
24+
description: Detail what the new document or section should cover.
25+
placeholder: "This document should cover..."
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: document-need
31+
attributes:
32+
label: Why is this needed?
33+
description: Explain the necessity of this new document or section.
34+
placeholder: "This is needed because..."
35+
validations:
36+
required: false
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 🌍 Translation
2+
description: Contribute or suggest translations for the documentation
3+
title: "[Translation]: "
4+
labels: ["translation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for contributing to our documentation's translation efforts!
10+
11+
- type: input
12+
id: language
13+
attributes:
14+
label: Language
15+
description: Specify the language for the translation.
16+
placeholder: "e.g., Spanish, French, German"
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: translation-details
22+
attributes:
23+
label: Translation Details
24+
description: Describe the translation work to be done or the specific sections/pages that need translation.
25+
placeholder: "I would like to translate the following sections..."
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: additional-info
31+
attributes:
32+
label: Additional Information
33+
description: Any additional context or information related to the translation.
34+
placeholder: "Additional details..."
35+
validations:
36+
required: false
Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
name: 💼 Add Issue to Project Task Board
2+
3+
on:
4+
issues:
5+
types:
6+
- opened
7+
8+
jobs:
9+
track_issue:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Get project data
13+
env:
14+
GH_TOKEN: ${{ secrets.PUSH_TO_PROJECT }}
15+
run: |
16+
gh api graphql -f query='
17+
query($owner: String!, $repo: String!) {
18+
repository(owner: $owner, name: $repo) {
19+
projectV2(number: 24) {
20+
id
21+
fields(first: 20) {
22+
nodes {
23+
... on ProjectV2Field {
24+
id
25+
name
26+
}
27+
... on ProjectV2SingleSelectField {
28+
id
29+
name
30+
options {
31+
id
32+
name
33+
}
34+
}
35+
}
36+
}
37+
}
38+
}
39+
}' -f owner=${{ github.repository_owner }} -f repo=${{ github.event.repository.name }} > project_data.json
40+
41+
PROJECT_ID=$(jq -r '.data.repository.projectV2.id' project_data.json)
42+
STATUS_FIELD_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Status") | .id' project_data.json)
43+
BACKLOG_OPTION_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Status") | .options[] | select(.name == "BackLog") | .id' project_data.json)
44+
DEPARTMENT_FIELD_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Department") | .id' project_data.json)
45+
MAIN_TASK_FIELD_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Main Task ID") | .id' project_data.json)
46+
SUB_TASK_FIELD_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Sub Task ID") | .id' project_data.json)
47+
CREATION_DATE_FIELD_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Creation Date") | .id' project_data.json)
48+
PRIORITY_FIELD_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Priority") | .id' project_data.json)
49+
SET_PRIORITY_OPTION_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Priority") | .options[] | select(.name == "Set A Priority!") | .id' project_data.json)
50+
DEPARTMENT_OPTION_ID=$(jq -r '.data.repository.projectV2.fields.nodes[] | select(.name == "Department") | .options[] | select(.name == "Development") | .id' project_data.json)
51+
52+
echo "PROJECT_ID=$PROJECT_ID" >> $GITHUB_ENV
53+
echo "STATUS_FIELD_ID=$STATUS_FIELD_ID" >> $GITHUB_ENV
54+
echo "BACKLOG_OPTION_ID=$BACKLOG_OPTION_ID" >> $GITHUB_ENV
55+
echo "DEPARTMENT_FIELD_ID=$DEPARTMENT_FIELD_ID" >> $GITHUB_ENV
56+
echo "MAIN_TASK_FIELD_ID=$MAIN_TASK_FIELD_ID" >> $GITHUB_ENV
57+
echo "SUB_TASK_FIELD_ID=$SUB_TASK_FIELD_ID" >> $GITHUB_ENV
58+
echo "CREATION_DATE_FIELD_ID=$CREATION_DATE_FIELD_ID" >> $GITHUB_ENV
59+
echo "PRIORITY_FIELD_ID=$PRIORITY_FIELD_ID" >> $GITHUB_ENV
60+
echo "SET_PRIORITY_OPTION_ID=$SET_PRIORITY_OPTION_ID" >> $GITHUB_ENV
61+
echo "DEPARTMENT_OPTION_ID=$DEPARTMENT_OPTION_ID" >> $GITHUB_ENV
62+
63+
- name: Add issue to project
64+
env:
65+
GH_TOKEN: ${{ secrets.PUSH_TO_PROJECT }}
66+
ISSUE_ID: ${{ github.event.issue.node_id }}
67+
PROJECT_ID: ${{ env.PROJECT_ID }}
68+
run: |
69+
project_item_id=$(gh api graphql -f query='
70+
mutation($project: ID!, $issue: ID!) {
71+
addProjectV2ItemById(input: {projectId: $project, contentId: $issue}) {
72+
item {
73+
id
74+
}
75+
}
76+
}' -f project=$PROJECT_ID -f issue=$ISSUE_ID --jq '.data.addProjectV2ItemById.item.id')
77+
echo "PROJECT_ITEM_ID=$project_item_id" >> $GITHUB_ENV
78+
79+
- name: Update project item fields
80+
env:
81+
GH_TOKEN: ${{ secrets.PUSH_TO_PROJECT }}
82+
PROJECT_ID: ${{ env.PROJECT_ID }}
83+
PROJECT_ITEM_ID: ${{ env.PROJECT_ITEM_ID }}
84+
DEPARTMENT_FIELD_ID: ${{ env.DEPARTMENT_FIELD_ID }}
85+
DEPARTMENT_OPTION_ID: ${{ env.DEPARTMENT_OPTION_ID }}
86+
MAIN_TASK_FIELD_ID: ${{ env.MAIN_TASK_FIELD_ID }}
87+
SUB_TASK_FIELD_ID: ${{ env.SUB_TASK_FIELD_ID }}
88+
BACKLOG_OPTION_ID: ${{ env.BACKLOG_OPTION_ID }}
89+
STATUS_FIELD_ID: ${{ env.STATUS_FIELD_ID }}
90+
CREATION_DATE_FIELD_ID: ${{ env.CREATION_DATE_FIELD_ID }}
91+
PRIORITY_FIELD_ID: ${{ env.PRIORITY_FIELD_ID }}
92+
SET_PRIORITY_OPTION_ID: ${{ env.SET_PRIORITY_OPTION_ID }}
93+
run: |
94+
if [ -n "$DEPARTMENT_FIELD_ID" ] && [ -n "$DEPARTMENT_OPTION_ID" ]; then
95+
gh api graphql -f query='
96+
mutation($projectId: ID!, $projectItemId: ID!, $fieldId: ID!, $value: String!) {
97+
updateProjectV2ItemFieldValue(input: {projectId: $projectId, itemId: $projectItemId, fieldId: $fieldId, value: {singleSelectOptionId: $value}}) {
98+
projectV2Item {
99+
id
100+
}
101+
}
102+
}' -f projectId=$PROJECT_ID -f projectItemId=$PROJECT_ITEM_ID -f fieldId=$DEPARTMENT_FIELD_ID -f value=$DEPARTMENT_OPTION_ID
103+
fi
104+
105+
if [ -n "$MAIN_TASK_FIELD_ID" ]; then
106+
gh api graphql -f query='
107+
mutation($projectId: ID!, $projectItemId: ID!, $fieldId: ID!, $value: String!) {
108+
updateProjectV2ItemFieldValue(input: {projectId: $projectId, itemId: $projectItemId, fieldId: $fieldId, value: {text: $value}}) {
109+
projectV2Item {
110+
id
111+
}
112+
}
113+
}' -f projectId=$PROJECT_ID -f projectItemId=$PROJECT_ITEM_ID -f fieldId=$MAIN_TASK_FIELD_ID -f value="Documentation - Stereum"
114+
fi
115+
116+
if [ -n "$SUB_TASK_FIELD_ID" ]; then
117+
LABEL_NAME="${{ github.event.issue.labels[0].name }}"
118+
if [[ "$LABEL_NAME" == "doc enhancement" ]]; then
119+
SUB_TASK_NAME="Documentation - Stereum | Doc Enhancement"
120+
elif [[ "$LABEL_NAME" == "fix" ]]; then
121+
SUB_TASK_NAME="Documentation - Stereum | Fix"
122+
elif [[ "$LABEL_NAME" == "new docs" ]]; then
123+
SUB_TASK_NAME="Documentation - Stereum | New Docs"
124+
elif [[ "$LABEL_NAME" == "translation" ]]; then
125+
SUB_TASK_NAME="Documentation - Stereum | Translation"
126+
else
127+
SUB_TASK_NAME="Documentation - Stereum | General"
128+
fi
129+
130+
gh api graphql -f query='
131+
mutation($projectId: ID!, $projectItemId: ID!, $fieldId: ID!, $value: String!) {
132+
updateProjectV2ItemFieldValue(input: {projectId: $projectId, itemId: $projectItemId, fieldId: $fieldId, value: {text: $value}}) {
133+
projectV2Item {
134+
id
135+
}
136+
}
137+
}' -f projectId=$PROJECT_ID -f projectItemId=$PROJECT_ITEM_ID -f fieldId=$SUB_TASK_FIELD_ID -f value="$SUB_TASK_NAME"
138+
fi
139+
140+
if [ -n "$STATUS_FIELD_ID" ] && [ -n "$BACKLOG_OPTION_ID" ]; then
141+
gh api graphql -f query='
142+
mutation($projectId: ID!, $projectItemId: ID!, $fieldId: ID!, $value: String!) {
143+
updateProjectV2ItemFieldValue(input: {projectId: $projectId, itemId: $projectItemId, fieldId: $fieldId, value: {singleSelectOptionId: $value}}) {
144+
projectV2Item {
145+
id
146+
}
147+
}
148+
}' -f projectId=$PROJECT_ID -f projectItemId=$PROJECT_ITEM_ID -f fieldId=$STATUS_FIELD_ID -f value=$BACKLOG_OPTION_ID
149+
fi
150+
151+
current_date=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
152+
153+
if [ -n "$CREATION_DATE_FIELD_ID" ]; then
154+
gh api graphql -f query='
155+
mutation($projectId: ID!, $projectItemId: ID!, $fieldId: ID!, $value: Date!) {
156+
updateProjectV2ItemFieldValue(input: {projectId: $projectId, itemId: $projectItemId, fieldId: $fieldId, value: {date: $value}}) {
157+
projectV2Item {
158+
id
159+
}
160+
}
161+
}' -f projectId=$PROJECT_ID -f projectItemId=$PROJECT_ITEM_ID -f fieldId=$CREATION_DATE_FIELD_ID -f value=$current_date
162+
fi
163+
164+
if [ -n "$PRIORITY_FIELD_ID" ] && [ -n "$SET_PRIORITY_OPTION_ID" ]; then
165+
gh api graphql -f query='
166+
mutation($projectId: ID!, $projectItemId: ID!, $fieldId: ID!, $value: String!) {
167+
updateProjectV2ItemFieldValue(input: {projectId: $projectId, itemId: $projectItemId, fieldId: $fieldId, value: {singleSelectOptionId: $value}}) {
168+
projectV2Item {
169+
id
170+
}
171+
}
172+
}' -f projectId=$PROJECT_ID -f projectItemId=$PROJECT_ITEM_ID -f fieldId=$PRIORITY_FIELD_ID -f value=$SET_PRIORITY_OPTION_ID
173+
fi

.github/workflows/deploy.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
name: Build Docusaurus
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
- uses: actions/setup-node@v4
17+
with:
18+
node-version: 18
19+
cache: npm
20+
21+
- name: Install dependencies
22+
run: npm ci
23+
- name: Build website
24+
run: npm run build
25+
26+
- name: Upload Build Artifact
27+
uses: actions/upload-pages-artifact@v3
28+
with:
29+
path: build
30+
31+
deploy:
32+
name: Deploy to GitHub Pages
33+
needs: build
34+
35+
permissions:
36+
pages: write
37+
id-token: write
38+
39+
environment:
40+
name: github-pages
41+
url: ${{ steps.deployment.outputs.page_url }}
42+
43+
runs-on: ubuntu-latest
44+
steps:
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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*

.prettierrc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"singleQuote": true,
3+
"tabWidth": 2
4+
}

README copy.md

Whitespace-only changes.

0 commit comments

Comments
 (0)