Update README
Fix a typo
Prepend bundle exec to middleman command
Use link_to_lang helper
Use relative path for links
Append solidus to links to directory index
Update Bundler
Install Webrick
Add Webrick to dependencies
Remove Crowdin related code from template
Co-authored-by: Kitaiti Makoto <KitaitiMakoto@gmail.com>
Reviewed-on: #113
The documentation for Plume, available at [docs.joinplu.me](https://docs.joinplu.me).
Uses middleman.
Uses [middleman][].
## Prerequisites
* Ruby
* [Crowdin CLI][] v3 if you build translations
* Netlify CLI if you deploy
## Setting up
Install RubyGems including [middleman][]:
```shell
bundle config set --local path vendor/bundle
bundle install
```
## Editing documentation
Run
```shell
bundle exec middleman
```
, visit http://localhost:4567/, and then you can see documentation site.
Edit files under `source` directory and reload your browser, then you see updated content. But this site doesn't include translations. If you want to include translated pages, see next section.
After editing, create a pull request.
## Building site with translation integration
If you want to build site with translations, you need set up [Crowdin CLI][].
Run
```shell
bundle exec rake build_site
```
and then the site with translations is built under `build` directory. You can see the site using one-liner server such as
```shell
ruby -run -e httpd build
```
or web server such as Caddy.
## Updating translation strings
When you add and/or modify strings from current sources, you may want to translate them. To do so, updated contents need to be uploaded to Crowdin. Run
```shell
bundle exec rake crowdin:upload
```
then you can translate strings at Crowdin.
## Building translation site
When you build site for https://translate.docs.joinplu.me/, run
```shell
bundle exec rake build_trans
```
then the site is built under `translate` directory.
## Deploying site
You need [Netlify CLI][] if you deploy site.
Run
```shel
bundle exec rake deploy
```
then you can see updated site at https://docs.joinplu.me/.
## Deploying translation site
Run
```shell
bundle exec rake deploy_trans
```
and then you can see updated translation site at https://translate.docs.joinplu.me/.
@ -19,5 +19,5 @@ Give as much details as possible. Especially, explain which problem you are tryi
Then you can open on [Gitea](https://git.joinplu.me/Plume/Plume/issues/new) ([GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md)),
if you have an account there. Just fill the information asked in the form, and click "Submit new issue".
If you don't have a Gitea nor GitHub account, you can also suggest your feature in [the Matrix room](/contribute/discussion), and we
If you don't have a Gitea nor GitHub account, you can also suggest your feature in [the Matrix room](../discussion/), and we
<p><b>Before contributing, be sure to read and agree with our <a href="/organization/code-of-conduct">Code of conduct</a></b></p>
<p><b>Before contributing, be sure to read and agree with our <a href="../../organization/code-of-conduct/">Code of conduct</a></b></p>
<p>Here is a (non-exhaustive) list of how you can contribute to Plume. Some may suit you better, depending on your skills and the time you want to offer to the project</p>
<li>Talk about the project (super easy, and super helpful)</li>
<li>Write articles on Plume</li>
<li><a href="/installation">Open your own instance</a></li>
<li><%= link_to "Open your own instance", "/installation/index.html" %></li>
<li>Make a security audit</li>
<li>Integrate Plume with other projects. For instance you could use the <a href="/API">API</a> to make it possible to publish on Plume from your favorite writing app</li>
<li>Integrate Plume with other projects. For instance you could use the <a href="../../API/">API</a> to make it possible to publish on Plume from your favorite writing app</li>
</ul>
<p>If you contributed to Plume, you can add yourself to the <a href="/organization/contributors">contributors page</a> if you want.</p>
<p>If you contributed to Plume, you can add yourself to the <%= link_to "contributors page", "/organization/contributors.html" %> if you want.</p>
<p>If you ever encounter some difficulties while trying to contribute, please <a href="/contribute/discussion">tell us</a>, we will be happy to help you.</p>
<p>If you ever encounter some difficulties while trying to contribute, please <%= link_to "tell us", "/contribute/discussion.html" %>, we will be happy to help you.</p>
@ -31,4 +31,4 @@ Language is the name of the language you are using.
The supported languages are those in [this repository](https://github.com/sublimehq/Packages/tree/fa6b8629c95041bf262d4c1dab95c456a0530122) since we use SublimeText's syntax file.
Usually the name is in lower-case: for instance `Python` can be highlighted with `python`.
To configure the theme to use, you will have to [choose a different theme for your bblog](/guide/manage-a-blog).
To configure the theme to use, you will have to [choose a different theme for your bblog](../manage-a-blog/).
And then, you can configure Plume by `SEARCH_TAG_TOKENIZER`, `SEARCH_CONTENT_TOKENIZER` and/or `SEARCH_LANG` environment variables. See [Useful Environment Variables](/environment/) for details.
And then, you can configure Plume by `SEARCH_TAG_TOKENIZER`, `SEARCH_CONTENT_TOKENIZER` and/or `SEARCH_LANG` environment variables. See [Useful Environment Variables](../../../environment/) for details.
For **Windows**, if you are going to use SQLite, launch an additional cmd.exe as admin and do the following:
@ -77,4 +77,4 @@ These commands can take a long time to run and use quite a lot of resources.
@ -38,13 +38,13 @@ Project maintainers have the right and responsibility to remove, edit, or reject
### Scope
This Code of Conduct applies both within [project spaces](/organization/where) and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
This Code of Conduct applies both within [project spaces](../where/) and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
### Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at moderation@joinplu.me. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
The members of the project team are the people marked as *Member of the moderation team* [on the contributors page](/organization/contributors).
The members of the project team are the people marked as *Member of the moderation team* [on the contributors page](../contributors/).
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.