Skip to content

Commit 02ffdd7

Browse files
committed
docs: update github docs and static docker build
1 parent 16304a7 commit 02ffdd7

File tree

2 files changed

+30
-21
lines changed

2 files changed

+30
-21
lines changed

Dockerfile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ COPY .npmrc ./
88

99
RUN npm ci
1010

11-
COPY public ./public
11+
COPY docs ./docs
1212
COPY src ./src
13+
COPY static ./static
14+
COPY docusaurus.config.js ./
15+
COPY sidebars.js ./
1316

1417
CMD [ "npm", "start"]
1518

README.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,39 @@
1-
# Website
1+
<div style="text-align: center" align="center">
2+
<img alt="Open Sauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px" />
23

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
# docs.opensauced.pizza
5+
> The path to your next Open Source contribution
46
5-
## Installation
7+
[![Commits](https://img.shields.io/github/commit-activity/w/open-sauced/explore.opensauced.pizza?style=flat)](https://github.com/open-sauced/explore.opensauced.pizza/pulse)
8+
[![Issues](https://img.shields.io/github/issues/open-sauced/explore.opensauced.pizza.svg?style=flat)](https://github.com/open-sauced/explore.opensauced.pizza/issues)
9+
[![Releases](https://img.shields.io/github/v/release/open-sauced/explore.opensauced.pizza.svg?style=flat)](https://github.com/open-sauced/explore.opensauced.pizza/releases)
10+
[![Discord](https://img.shields.io/discord/714698561081704529.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/U2peSNf23P)
11+
[![Twitter](https://img.shields.io/twitter/follow/saucedopen?label=Follow&style=social)](https://twitter.com/saucedopen)
612

7-
```console
8-
yarn install
9-
```
13+
</div>
1014

11-
## Local Development
15+
## 🧪 Built for Experimenting
1216

13-
```console
14-
yarn start
15-
```
17+
This tool is meant to accelerate development on [Open Sauced](https://opensauced.pizza) by giving contributors a way to access [Docusaurus 2](https://docusaurus.io/) powered developer documentation available at [docs.opensauced.pizza](https://docs.opensauced.pizza).
18+
19+
## 🤝 Contributing
1620

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
21+
We encourage you to contribute to Open Sauced! Please check out the [Contributing guide](CONTRIBUTING.md) for guidelines about how to proceed.
1822

19-
## Build
23+
<img align="right" src="https://i.ibb.co/CJfW18H/ship.gif" width="200"/>
2024

21-
```console
22-
yarn build
25+
## 🖥️ Development
26+
27+
```sh
28+
npm ci
29+
npm start
2330
```
2431

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
32+
## 🍕 Community
2633

27-
## Deployment
34+
Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).
35+
Find Open Sauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ).
2836

29-
```console
30-
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
31-
```
37+
## ⚖️ LICENSE
3238

33-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
39+
MIT © [Open Sauced](LICENSE)

0 commit comments

Comments
 (0)