mirror of https://github.com/acid-info/vac.dev.git
update README
Signed-off-by: ksr <kaiserd@users.noreply.github.com>
This commit is contained in:
ksr
parent
a096aec365
commit
4705c1933a
99
README.md
99
README.md
|
|
@ -1,9 +1,26 @@
|
|||
# Waku Blog
|
||||
This repository contains the source for vac.dev.
|
||||
|
||||
The template repository for blogs using [logos-docusaurus-plugins](https://github.com/acid-info/logos-docusaurus-plugins)
|
||||
# Vac Research Blog
|
||||
|
||||
## Adding posts
|
||||
|
||||
## How to Run Locally
|
||||
To publish in the blog, create a `.md` or `mdx` file within the `posts` directory.
|
||||
Please follow [sembr](https://sembr.org/) in the `.md` or `.mdx` file.
|
||||
You can use [Frontmatter](https://docusaurus.io/docs/markdown-features#front-matter) to add metadata to your markdown file.
|
||||
|
||||
### CI/CD
|
||||
|
||||
- The `master` branch is automatically deployed to the production server (e.g., logos.co) through [CI](https://ci.infra.status.im)
|
||||
- The `develop` branch is automatically deployed to the staging server (e.g., dev.logos.co) through [CI](https://ci.infra.status.im)
|
||||
|
||||
### Change Process
|
||||
|
||||
1. Create a new working branch from `develop`: `git checkout develop; git checkout -b my-changes`.
|
||||
2. Make your changes, push them to the `origin`, and open a Pull Request against the `develop` branch.
|
||||
3. After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
|
||||
4. When ready to promote changes to the live website, rebase the `master` branch on the staging changes: `git checkout master; git pull origin master; git rebase origin/develop; git push`.
|
||||
|
||||
### How to Run Locally
|
||||
|
||||
1. Clone this repository
|
||||
```bash
|
||||
|
|
@ -22,33 +39,11 @@ $ yarn start
|
|||
|
||||
4. Visit `http://localhost:3000/` in your browser
|
||||
|
||||
## Further Info and Configuration
|
||||
|
||||
## Configuration
|
||||
Edit the `docusaurus.config.js` file in the repository's root directory, and update the value of the `businessUnit` field in presets section; below is a list of valid values:
|
||||
- Logos
|
||||
- Codex
|
||||
- Waku
|
||||
- Nimbus
|
||||
- Nomos
|
||||
- VacResearch
|
||||
- Acid.info
|
||||
> *Note*: The following contains options that go beyond what is needed to add new blog posts. To simply add a blog post, follow the steps listed above.
|
||||
|
||||
Example:
|
||||
```js
|
||||
presets: [
|
||||
[
|
||||
'@acid-info/logos-docusaurus-preset',
|
||||
{
|
||||
businessUnit: 'Codex',
|
||||
},
|
||||
],
|
||||
],
|
||||
```
|
||||
|
||||
This is typically sufficient for most cases, as the Logos plugins will automatically populate other configurations related to the specified business unit. If you encounter any errors in the information provided by Logos Plugins, please visit the [Logos Docusaurus Plugins](https://github.com/acid-info/logos-docusaurus-plugins) repository and open an issue.
|
||||
|
||||
|
||||
## Blog Setup
|
||||
### Blog Setup
|
||||
|
||||
The blog utilizes the Docusaurus blog plugin configured in `docusaurus.config.js`.
|
||||
|
||||
|
|
@ -74,27 +69,37 @@ A list of authors can be defined in `/posts/authors.yml`.
|
|||
For additional customization options, please refer to the [Docusaurus Blog Plugin documentation](https://docusaurus.io/docs/blog).
|
||||
|
||||
|
||||
## Adding posts
|
||||
|
||||
To publish in the blog, create a `.md` or `mdx` file within the `posts` directory. You can use [Frontmatter](https://docusaurus.io/docs/markdown-features#front-matter) to add metadata to your markdown file.
|
||||
|
||||
|
||||
## Customization
|
||||
### Customization
|
||||
|
||||
You can find instructions for adding additional documentation sections, implementing localization, and managing versioning on the [Docusaurus](https://docusaurus.io/docs) website.
|
||||
|
||||
> Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme, visit the [Logos Docusaurus Theme](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/) repository.
|
||||
> Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme,
|
||||
visit the [Logos Docusaurus Theme](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/) repository.
|
||||
|
||||
### Configuration
|
||||
|
||||
Edit the `docusaurus.config.js` file in the repository's root directory, and update the value of the `businessUnit` field in presets section; below is a list of valid values:
|
||||
- Logos
|
||||
- Codex
|
||||
- Waku
|
||||
- Nimbus
|
||||
- Nomos
|
||||
- VacResearch
|
||||
- Acid.info
|
||||
|
||||
Example:
|
||||
```js
|
||||
presets: [
|
||||
[
|
||||
'@acid-info/logos-docusaurus-preset',
|
||||
{
|
||||
businessUnit: 'Codex',
|
||||
},
|
||||
],
|
||||
],
|
||||
```
|
||||
|
||||
This is typically sufficient for most cases, as the Logos plugins will automatically populate other configurations related to the specified business unit.
|
||||
If you encounter any errors in the information provided by Logos Plugins, please visit the [Logos Docusaurus Plugins](https://github.com/acid-info/logos-docusaurus-plugins) repository and open an issue.
|
||||
|
||||
|
||||
## CI/CD
|
||||
|
||||
- The `master` branch is automatically deployed to the production server (e.g., logos.co) through [CI](https://ci.infra.status.im)
|
||||
- The `develop` branch is automatically deployed to the staging server (e.g., dev.logos.co) through [CI](https://ci.infra.status.im)
|
||||
|
||||
|
||||
## Change Process
|
||||
|
||||
1. Create a new working branch from `develop`: `git checkout develop; git checkout -b my-changes`.
|
||||
2. Make your changes, push them to the `origin`, and open a Pull Request against the `develop` branch.
|
||||
3. After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
|
||||
4. When ready to promote changes to the live website, rebase the `master` branch on the staging changes: `git checkout master; git pull origin master; git rebase origin/develop; git push`.
|
||||
|
|
|
|||
Loading…
Reference in New Issue