Skip to content
This repository was archived by the owner on Sep 8, 2023. It is now read-only.

Commit 85d9f54

Browse files
Jake PageJake Page
Jake Page
authored and
Jake Page
committed
initial commit with docusaurus transfer
1 parent 9f2a568 commit 85d9f54

File tree

111 files changed

+22320
-13673
lines changed

Some content is hidden

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

111 files changed

+22320
-13673
lines changed

Diff for: ‎.github/workflows/hello-msg-new-contributors.yml

-20
This file was deleted.

Diff for: ‎.gitignore

+19
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
112
.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*

Diff for: ‎README.md

+35-8
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,42 @@
1-
# The Komiser Documentation
1+
![Example banner](./static/img/docusaurus-oraculi-logo-transparent.png)
2+
<h1>Official Oraculi Documentation</h1>
3+
<p>
4+
Repository for the Oraculi Organization Public Documentation. It is the official Oraculi site for publishing latest news, blog posts, and documentation from our open source community.
5+
</p>
26

3-
This repository contains the files required to build the Komiser Documentation Hub. To any [contributors](https://github.com/komiserio/docs/blob/master/docs/contributing.md) willing for add to the project, before anything else, Thank you!
7+
</div>
48

5-
## Contributing to the docs
9+
## How To Run Tests
610

7-
- Firstly, go ahead and **fork** the docs repository. Make any changes you want to your fork, and when you're ready to send those changes to us, go to your fork and create a new pull request.
11+
In order to make sure your changes have not broken anything, you can run the following commands before pushing your changes to gitHub.
812

9-
- If it takes longer than expected to get feedback from the `Oraculi` team, head over to the [Discord Server](https://discord.oraculi.io) and **ping** an Oraculi staff member either in the `#general` or `#feedback` channel, unless you are a member of the private `contributor` channel. You can always request access to this channel.
13+
```sh
14+
npm install
15+
npm test
16+
```
1017

11-
- Once your pull request is created, an `Oraculi` reviewer will provide clear and actionable feedback to you. As the owner of the pull request, it is your responsibility to modify it to address the feedback that has been provided.
18+
### How to Run Locally
1219

13-
- Once the PR is approved, it will be merged to master and you will then become and official contributor, congrats!
20+
1. Clone this repository: `git clone "https://github.com/HelloOraculi/docusaurus.git"`
21+
2. Run the commands :
22+
1. `npm install`
23+
2. `npm run docusaurus:build`
24+
3. `npm run docusaurus:serve`
25+
3. The site will be running locally on `http://localhost:3000`
1426

15-
If you are in need of any assiatance at any stage of you contributing experience please don't hesitate to reach out to anybody in the `#contributors` discord channel. Or directly to `@mlabouardy` or `@JakePage` who will always be happy to help.
27+
### How To Contribute To the Documentation
28+
29+
1. Fork this repository
30+
2. Create your documentation branch: `git checkout -b branch-name`
31+
3. Make changes to the documentation in markdown
32+
4. Add changes to the staging area `git add .`
33+
5. Commit your changes using the command `git commit -m 'commit message'`
34+
6. Push your changes to gitHub `git push origin branch-name`
35+
7. Create new Pull Request
36+
37+
38+
## History
39+
40+
### v1.0.0 (Aug, 2022)
41+
42+
![HELLO](https://youtu.be/yKNxeF4KMsY))

Diff for: ‎babel.config.js

+3
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+
};

Diff for: ‎blog/2019-05-28-first-blog-post.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
slug: first-blog-post
3+
title: First Blog Post
4+
authors:
5+
name: Gao Wei
6+
title: Docusaurus Core Team
7+
url: https://github.com/wgao19
8+
image_url: https://github.com/wgao19.png
9+
tags: [hola, docusaurus]
10+
---
11+
12+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Diff for: ‎blog/2019-05-29-long-blog-post.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
slug: long-blog-post
3+
title: Long Blog Post
4+
authors: endi
5+
tags: [hello, docusaurus]
6+
---
7+
8+
This is the summary of a very long blog post,
9+
10+
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
11+
12+
<!--truncate-->
13+
14+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
15+
16+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17+
18+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
19+
20+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
21+
22+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
23+
24+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
25+
26+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
27+
28+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
29+
30+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
31+
32+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
33+
34+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
35+
36+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
37+
38+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
39+
40+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
41+
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
43+
44+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Diff for: ‎blog/2021-08-01-mdx-blog-post.mdx

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
slug: mdx-blog-post
3+
title: MDX Blog Post
4+
authors: [slorber]
5+
tags: [docusaurus]
6+
---
7+
8+
Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
9+
10+
:::tip
11+
12+
Use the power of React to create interactive blog posts.
13+
14+
```js
15+
<button onClick={() => alert('button clicked!')}>Click me!</button>
16+
```
17+
18+
<button onClick={() => alert('button clicked!')}>Click me!</button>
19+
20+
:::

Diff for: ‎blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg

93.9 KB
Loading

Diff for: ‎blog/2021-08-26-welcome/index.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
slug: welcome
3+
title: Welcome
4+
authors: [slorber, yangshun]
5+
tags: [facebook, hello, docusaurus]
6+
---
7+
8+
[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
9+
10+
Simply add Markdown files (or folders) to the `blog` directory.
11+
12+
Regular blog authors can be added to `authors.yml`.
13+
14+
The blog post date can be extracted from filenames, such as:
15+
16+
- `2019-05-30-welcome.md`
17+
- `2019-05-30-welcome/index.md`
18+
19+
A blog post folder can be convenient to co-locate blog post images:
20+
21+
![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
22+
23+
The blog supports tags as well!
24+
25+
**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

Diff for: ‎blog/authors.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
endi:
2+
name: Endilie Yacop Sucipto
3+
title: Maintainer of Docusaurus
4+
url: https://github.com/endiliey
5+
image_url: https://github.com/endiliey.png
6+
7+
yangshun:
8+
name: Yangshun Tay
9+
title: Front End Engineer @ Facebook
10+
url: https://github.com/yangshun
11+
image_url: https://github.com/yangshun.png
12+
13+
slorber:
14+
name: Sébastien Lorber
15+
title: Docusaurus maintainer
16+
url: https://sebastienlorber.com
17+
image_url: https://github.com/slorber.png

Diff for: ‎docs/Introduction/community.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Community
2+
3+
## TO BE FILLED IN AFTERWARDS
4+
5+
This section is a high-level overview of how the Oraculi Community section is structured.

Diff for: ‎docs/Introduction/contribute.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contribute
2+
3+
This repository contains the files required to build the Komiser Documentation Hub. To any [contributors](https://github.com/komiserio/docs/blob/master/docs/contributing.md) willing for add to the project, before anything else, Thank you!
4+
5+
## Contributing to the docs
6+
7+
- Firstly, go ahead and **fork** the docs repository. Make any changes you want to your fork, and when you're ready to send those changes to us, go to your fork and create a new pull request.
8+
9+
- If it takes longer than expected to get feedback from the `Oraculi` team, head over to the [Discord Server](https://discord.oraculi.io) and **ping** an Oraculi staff member either in the `#general` or `#feedback` channel, unless you are a member of the private `contributor` channel. You can always request access to this channel.
10+
11+
- Once your pull request is created, an `Oraculi` reviewer will provide clear and actionable feedback to you. As the owner of the pull request, it is your responsibility to modify it to address the feedback that has been provided.
12+
13+
- Once the PR is approved, it will be merged to master and you will then become and official contributor, congrats!
14+
15+
If you are in need of any assiatance at any stage of you contributing experience please don't hesitate to reach out to anybody in the `#contributors` discord channel. Or directly to `@mlabouardy` or `@JakePage` who will always be happy to help.

Diff for: ‎docs/Introduction/getting-started.md

+146
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Getting Started
2+
3+
## Installation
4+
5+
You can install the CLI with a `curl` utility script or by downloading the binary from the releases page. Once installed you'll get the `komiser` command.
6+
7+
### Linux:
8+
9+
```
10+
wget https://cli.komiser.io/2.9.0/linux/komiser
11+
```
12+
13+
### Windows:
14+
15+
```
16+
wget https://cli.komiser.io/2.9.0/windows/komiser -OutFile komiser.exe
17+
```
18+
19+
### Mac OS X:
20+
21+
```
22+
wget https://cli.komiser.io/2.9.0/osx/komiser
23+
```
24+
25+
!!! Note
26+
Make sure to add the execution permission to Komiser `chmod +x komiser`.
27+
28+
29+
### Homebrew installation:
30+
31+
```
32+
brew tap HelloOraculi/komiser
33+
brew install komiser
34+
```
35+
36+
### Install Komiser CLI locally:
37+
38+
<div style={{
39+
position: 'relative',
40+
paddingBottom: '56.25%',
41+
paddingTop:'30px',
42+
height:0,
43+
overflow:'hidden',
44+
}}>
45+
<iframe
46+
src='https://www.loom.com/embed/27d586a54cef49f3b394085afb119afa'
47+
allowFullScreen
48+
webkitallowfullscreen="true"
49+
frameBorder="0"
50+
style={{
51+
position: 'absolute',
52+
top:0,
53+
left:0,
54+
width:'100%',
55+
height:'100%',
56+
}}
57+
>
58+
</iframe>
59+
</div>
60+
61+
### Docker image
62+
63+
Komiser is also available as a Docker image:
64+
65+
[https://hub.docker.com/r/mlabouardy/komiser/tags/](https://hub.docker.com/r/mlabouardy/komiser/tags/)
66+
67+
There is no "latest" tag, so find the version of the CLI you want to use from the tags page on the Docker Hub. These correspond to the release from GitHub.
68+
69+
```
70+
docker run -d -p 3000:3000 --name komiser mlabouardy/komiser:2.9.0
71+
```
72+
73+
### Docker installation:
74+
75+
<div style={{
76+
position: 'relative',
77+
paddingBottom: '56.25%',
78+
paddingTop:'30px',
79+
height:0,
80+
overflow:'hidden',
81+
}}>
82+
<iframe
83+
src='https://www.youtube.com/embed/t6lNdQx9eNg'
84+
allowFullScreen
85+
webkitallowfullscreen="true"
86+
frameBorder="0"
87+
style={{
88+
position: 'absolute',
89+
top:0,
90+
left:0,
91+
width:'100%',
92+
height:'100%',
93+
}}
94+
>
95+
</iframe>
96+
</div>
97+
98+
#### Kubernetes (Helm chart) installation:
99+
100+
<div style={{
101+
position: 'relative',
102+
paddingBottom: '56.25%',
103+
paddingTop:'30px',
104+
height:0,
105+
overflow:'hidden',
106+
}}>
107+
<iframe
108+
src='https://www.youtube.com/embed/3J0t-fWHDbs'
109+
allowFullScreen
110+
webkitallowfullscreen="true"
111+
frameBorder="0"
112+
style={{
113+
position: 'absolute',
114+
top:0,
115+
left:0,
116+
width:'100%',
117+
height:'100%',
118+
}}
119+
>
120+
</iframe>
121+
</div>
122+
123+
#### Multiple account EKS (Helm chart) installation:
124+
125+
<div style={{
126+
position: 'relative',
127+
paddingBottom: '56.25%',
128+
paddingTop:'30px',
129+
height:0,
130+
overflow:'hidden',
131+
}}>
132+
<iframe
133+
src='https://www.youtube.com/embed/pYfjHKM1gzw'
134+
allowFullScreen
135+
webkitallowfullscreen="true"
136+
frameBorder="0"
137+
style={{
138+
position: 'absolute',
139+
top:0,
140+
left:0,
141+
width:'100%',
142+
height:'100%',
143+
}}
144+
>
145+
</iframe>
146+
</div>

Diff for: ‎docs/Introduction/what-is-komiser.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# What is Komiser

0 commit comments

Comments
 (0)