Skip to content
This repository was archived by the owner on May 3, 2022. It is now read-only.

Commit 8e25126

Browse files
HarshCasperNick Vidal
HarshCasper
authored and
Nick Vidal
committed
CHORE: Migrate the entire Enarx docs to the website
1 parent 0dd8385 commit 8e25126

File tree

348 files changed

+15123
-0
lines changed

Some content is hidden

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

348 files changed

+15123
-0
lines changed

‎.eslintrc.json

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"env": {
3+
"browser": true,
4+
"es2021": true
5+
},
6+
"extends": [
7+
"eslint:recommended",
8+
"plugin:react/recommended",
9+
"standard",
10+
"plugin:prettier/recommended"
11+
],
12+
"parserOptions": {
13+
"ecmaFeatures": {
14+
"jsx": true
15+
},
16+
"ecmaVersion": 12,
17+
"sourceType": "module"
18+
},
19+
"plugins": ["react"],
20+
"rules": {
21+
"prettier/prettier": [
22+
"warn",
23+
{
24+
"endOfLine": "auto"
25+
},
26+
{
27+
"usePrettierrc": true
28+
}
29+
],
30+
"react/prop-types": 0,
31+
"react/react-in-jsx-scope": 0
32+
},
33+
"settings": {
34+
"react": {
35+
"version": "detect"
36+
}
37+
}
38+
}

‎.github/workflows/ci.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Website CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
build:
13+
name: Build Frontend Project
14+
runs-on: ubuntu-latest
15+
if: |
16+
!contains(github.event.head_commit.message, 'skip-ci')
17+
steps:
18+
- uses: actions/checkout@v2
19+
20+
- name: Use Node.js 16.x
21+
uses: actions/setup-node@v2
22+
with:
23+
node-version: '16.x'
24+
25+
- name: Install dependencies
26+
run: yarn install
27+
28+
- name: Run ESLint
29+
run: yarn lint
30+
31+
- name: Build the website
32+
run: yarn build

‎.gitignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.DS_Store
2+
.vscode
3+
.idea
4+
*.iml
5+
*.code-workspace
6+
.changelog
7+
8+
node_modules
9+
.yarn
10+
11+
.eslintcache
12+
13+
yarn-error.log
14+
build
15+
coverage
16+
.docusaurus
17+
.cache-loader

‎.prettierrc.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"printWidth": 100,
3+
"tabWidth": 2,
4+
"semi": true,
5+
"singleQuote": true,
6+
"trailingComma": "es5",
7+
"proseWrap": "never",
8+
"bracketSpacing": true,
9+
"jsxBracketSameLine": false
10+
}

‎CODE_OF_CONDUCT.md

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

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License
2+
3+
Copyright (c) https://enarx.dev
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Enarx Docs
2+
3+
This repository contains the assets required to build the [Enarx website and documentation](https://enarx.dev/). We're glad that you want to contribute!
4+
5+
----
6+
7+
## Prerequisites
8+
9+
To install the website locally and build it, you need the following installed:
10+
11+
- [NodeJS](https://nodejs.org/)
12+
- [Yarn](https://yarnpkg.com/)
13+
14+
Before you start, install the dependencies. Clone the repository and navigate to the directory:
15+
16+
```sh
17+
git clone https://github.com/enarx/docs.git
18+
cd docs
19+
```
20+
21+
The Enarx website uses [Docusaurus](https://docusaurus.io/) to build a customizable and optimized website.
22+
23+
----
24+
25+
## Running the website
26+
27+
To start a local development server, run the following command:
28+
29+
```sh
30+
yarn start
31+
```
32+
33+
This starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
34+
35+
----
36+
37+
## Building the website
38+
39+
To build the website, run the following command:
40+
41+
```sh
42+
yarn build
43+
```
44+
45+
This command generates static content into the `build` directory and can be served using any static contents hosting service. You can run the following command to serve the build:
46+
47+
```sh
48+
yarn serve
49+
```
50+
51+
----
52+
53+
## Contributing to the docs
54+
55+
Click the Fork button in the upper-right area of the screen to create a fork of this repository in your GitHub account. Create a branch off the `main` and make any changes you want in your fork. Create a new pull request to help us know about your proposed changes so that we can provide actionable feedback. As a pull request owner, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the reviewer.
56+
57+
After all the comments are addressed, please let us know and we will merge your pull request. Contributions are welcome to make our documentation more accessible and readable, adding new features to help a wider audience know about Enarx and help onboard new contributors and users.
58+
59+
Participation in the Enarx community is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
60+
61+
You can engage with us on the following channels:
62+
63+
- [Chat](https://chat.enarx.dev)
64+
- [Meetings](https://enarx.dev/meetings)
65+
66+
----
67+
68+
## License
69+
70+
[MIT License](LICENSE)

‎babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

‎docs/Contributing/Bugs.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Bugs
2+
The Enarx project welcomes contributions!
3+
4+
Would you like to help with the development of Enarx?
5+
6+
This page will help you understand how we use the issue tracker and give you
7+
insight into reporting useful and helpful bugs.
8+
9+
## Issues and Bugs
10+
All our work takes place in the main [enarx/enarx](https://github.com/enarx/enarx) repo.
11+
12+
To keep our work organise, we make heavy use of labels. These allow us to quickly see all issues relating to conferences, infrastructure or WebAssembly, for instance. Here are the labels we use:
13+
14+
- [documentation](https://github.com/enarx/enarx/labels/documentation): Improvements or additions to documentation
15+
- [bug](https://github.com/enarx/enarx/labels/bug): Something isn't working
16+
- [duplicate](https://github.com/enarx/enarx/labels/duplicate): This issue or pull request already exists
17+
- [enhancement](https://github.com/enarx/enarx/labels/enhancement): New feature or request
18+
- [expert help needed](https://github.com/enarx/enarx/labels/expert%20help%20needed):This needs special attention from an area specialist.
19+
- [good first issue](https://github.com/enarx/enarx/labels/good%20first%20issue): Good for newcomers
20+
- [help wanted](https://github.com/enarx/enarx/labels/help%20wanted): Extra attention is needed
21+
- [infrastructure](https://github.com/enarx/enarx/labels/infrastructure): Improvements or additions to project infrastructure
22+
- [invalid](https://github.com/enarx/enarx/labels/invalid): This doesn't seem right
23+
- [question](https://github.com/enarx/enarx/labels/question): Further information is requested
24+
- [tech debt](https://github.com/enarx/enarx/labels/tech-debt): Issues that we recognize create technical debt which will need to be addressed later on. Helps to make this obvious and start planning for it.
25+
- [technology/sev](https://github.com/enarx/enarx/labels/technology%2Fsev): All SEV related issues
26+
- [technology/sgx](https://github.com/enarx/enarx/labels/technology%2Fsgx): All SGX related issues
27+
- [technology/wasm](https://github.com/enarx/enarx/labels/technology%20wasm): All WASM related issues
28+
- [wontfix](https://github.com/enarx/enarx/labels/wontfix): Issuses that will not be worked on
29+
30+
You can click on a label name to see the issues that have been tagged with it.

0 commit comments

Comments
 (0)