feat(docs): add docs to semaphoreio repo (#163)

Author: forestileao

.semaphore/daily-builds.yml

@@ -539,6 +539,52 @@ blocks:
         - name: "\U0001F9EA Test"
           commands:
             - make test.ex
+  # Docs
+  - name: "Docs: \U0001F5BC️ Provision Prod Image"
+    dependencies: []
+    task:
+      env_vars:
+        - name: APP_ENV
+          value: prod
+      jobs:
+        - name: "Image Build"
+          commands:
+            - checkout
+            - cd docs
+            - make build
+            - make push
+  - name: "Docs: \U0001F5BC️ Build test image"
+    dependencies: []
+    task:
+      env_vars:
+        - name: APP_ENV
+          value: dev
+      jobs:
+        - name: "Image Build"
+          commands:
+            - checkout
+            - cd docs
+            - make build
+            - make push
+  - name: "Docs: \U0001F9EA QA"
+    dependencies: ["Docs: \U0001F5BC️ Build test image"]
+    task:
+      env_vars:
+        - name: APP_ENV
+          value: dev
+      prologue:
+        commands:
+          - checkout
+          - cd docs
+          - make pull
+          - make build
+      jobs:
+        - name: Lint
+          commands:
+            - make lint
+        - name: Test
+          commands:
+            - make test
   # Front
   - name: "Front: \U0001F5BC️ Provision Test Image"
     dependencies: []

.semaphore/semaphore.yml

@@ -586,6 +586,58 @@ blocks:
         - name: "\U0001F9EA Test"
           commands:
             - make test.ex
+  # Docs
+  - name: "Docs: \U0001F5BC️ Provision Prod Image"
+    dependencies: []
+    run:
+      when: "change_in('/docs', {default_branch: 'main'})"
+    task:
+      env_vars:
+        - name: APP_ENV
+          value: prod
+      jobs:
+        - name: "Image Build"
+          commands:
+            - checkout
+            - cd docs
+            - make build
+            - make push
+  - name: "Docs: \U0001F5BC️ Build test image"
+    dependencies: []
+    run:
+      when: "change_in('/docs', {default_branch: 'main'})"
+    task:
+      env_vars:
+        - name: APP_ENV
+          value: dev
+      jobs:
+        - name: "Image Build"
+          commands:
+            - checkout
+            - cd docs
+            - make build
+            - make push
+  - name: "Docs: \U0001F9EA QA"
+    dependencies: ["Docs: \U0001F5BC️ Build test image"]
+    run:
+      when: "change_in('/docs', {default_branch: 'main'})"
+    task:
+      env_vars:
+        - name: APP_ENV
+          value: dev
+      prologue:
+        commands:
+          - checkout
+          - cd docs
+          - make pull
+          - make build
+      jobs:
+        - name: Lint
+          commands:
+            - make lint
+        - name: Test
+          commands:
+            - make test
   # Front
   - name: "Front: \U0001F5BC️ Provision Test Image"
     dependencies: []

.semaphore/services.json

@@ -48,6 +48,12 @@
         "component": "dashboardhub"
       }
     ],
+    "Docs": [
+      {
+        "path": "docs",
+        "component": "docs-v2"
+      }
+    ],
     "Encryptor": [
       {
         "path": "encryptor",

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/.markdownlint.json

@@ -0,0 +1,16 @@
+{
+    "default": true,
+    "line-length": false,
+    "single-trailing-newline": false,
+    "no-trailing-punctuation": false,
+    "no-duplicate-heading": false,
+    "no-trailing-spaces": false,
+    "blanks-around-fences": false,
+    "blanks-around-lists": false,
+    "no-multiple-blanks": false,
+    "no-inline-html": false,
+    "code-block-style": false,
+    "no-bare-urls": false,
+    "emphasis-style": false,
+    "single-title": { "front_matter_title": "$disable" }
+}

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

docs/Dockerfile

@@ -0,0 +1,48 @@
+ARG RUNNER_IMAGE=nginx
+
+# Build stage
+FROM node AS builder
+WORKDIR /app
+
+COPY package.json package.json
+COPY package-lock.json package-lock.json
+COPY yarn.lock yarn.lock
+COPY babel.config.js babel.config.js
+COPY docusaurus.config.js docusaurus.config.js
+COPY sidebars.js sidebars.js
+COPY versions.json versions.json
+COPY docs docs
+COPY docs-drafts docs-drafts
+COPY src src
+COPY static static
+COPY versioned_docs versioned_docs
+COPY versioned_sidebars versioned_sidebars
+COPY .markdownlint.json .markdownlint.json
+
+RUN npm install --frozen-lockfile
+RUN npm run clear
+RUN npm run build
+
+# Dev stage with both Node.js and Nginx
+FROM builder AS dev
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install --no-install-recommends -y nginx \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /app /app
+COPY default.conf /etc/nginx/conf.d/default.conf
+COPY --from=builder /app/build/ /usr/share/nginx/html/
+
+CMD ["nginx", "-g", "daemon off;"]
+
+# Runner
+FROM ${RUNNER_IMAGE} AS runner
+
+WORKDIR /app
+
+ADD default.conf /etc/nginx/conf.d/default.conf
+COPY --from=builder /app/build/ /usr/share/nginx/html/
+
+

docs/Makefile

@@ -0,0 +1,20 @@
+include ../Makefile
+
+APP_NAME=docs-v2
+APP_ENV?=dev
+
+npm.dev:
+	npm start
+
+npm.lint:
+	npm run lint
+
+npm.build:
+	npm run build
+
+lint:
+	docker run --rm -t -a stdout $(IMAGE):$(IMAGE_TAG) npm run lint
+
+test:
+	docker run --rm -t -a stdout $(IMAGE):$(IMAGE_TAG) nginx -c /etc/nginx/nginx.conf -t
+

docs/README.md

@@ -0,0 +1,35 @@
+# Semaphore Docs
+
+This repo contains the source for the Semaphore docs site, including the content of the docs and docs engine.
+
+If you notice that something is vague, inaccurate, or incomplete about the documentation, or have an idea for a great guide, we encourage you to create a GitHub issue in this repository using our [issue template](./).
+
+## Contribution
+
+To learn how to contribute to the Semaphore docs site, please refer to the following guides:
+
+- [How to Contribute](./docs-contributing/CONTRIBUTING.md): A comprehensive guide to making changes to the Semaphore documentation.
+- [How to Review](./docs-contributing/REVIEWING.md): Instructions on how to set up a local preview site to review documentation changes.
+- [Style Guide](./docs-contributing/STYLE_GUIDE.md): Guidelines for maintaining consistency in the Semaphore documentation.
+- [UI Reference](./docs-contributing/UI-REFERENCE.md): A reference for UI components available to documentation authors.
+
+## Top Contributors
+
+Contributors list is WIP
+
+## Ongoing work
+
+👉 [Help Wanted Board](https://github.com/orgs/semaphoreci/projects/2/views/7) 👈
+
+## SIG meetings
+
+Documentation team meets weekly. Meeting agenda is always published one week prior. All contributors are welcome, open an issue to join the SIG and get a calendar invite.
+
+- 💬 [Join the Discord channel](https://discord.gg/FBuUrV24NH)
+- 📆 Every `Monday` at `1pm UTC`
+- 📝 [Meeting minutes](https://github.com/semaphoreci/semaphore/blob/main/docs/docs-contributing/meeting-notes.md)
+- 🙋‍♂️ [Join the SIG](https://forms.gle/tcNpGA4Zyghnu7sh8) < select `SIG - Docummentation` when filling in form.
+
+## License
+
+All Semaphore documentation and any resources under `/docs/` folder fall under the Apache v2 license present at the root of this repository.