doc-typo #100

Marius · 2020-12-05T22:41:53Z

Marius commented

2020-12-05 22:41:53 +00:00

These are small corrections of typos, adding Caddy v2 syntax for reverse_proxy and standardization of github links.

In source/contribute/code-review.html.md there is mention of websites https://pr-list.joinplu.me and https://pr-XXX.joinplu.me but they seem to be down, so i think this must be at least commented (actual state) or removed.

Also in file source/organization/contributors.html.md it is still Ana which is mentionned as principal contact to be added, but maybe it must be replaced by KitaitiMakoto now ?

I'll fix that as soon as there is opinions on the two last modification.

Thanks for reviewing this :)

These are small corrections of typos, adding Caddy v2 syntax for reverse_proxy and standardization of github links. In *source/contribute/code-review.html.md* there is mention of websites **https://pr-list.joinplu.me** and **https://pr-XXX.joinplu.me** but they seem to be down, so i think this must be at least commented (actual state) or removed. Also in file *source/organization/contributors.html.md* it is still Ana which is mentionned as principal contact to be added, but maybe it must be replaced by KitaitiMakoto now ? I'll fix that as soon as there is opinions on the two last modification. Thanks for reviewing this :)

KitaitiMakoto commented

2020-12-06 06:18:10 +00:00

Thank you for great pull request. Especially Caddyfile modification is so helpful.

In source/contribute/code-review.html.md there is mention of websites https://pr-list.joinplu.me and https://pr-XXX.joinplu.me but they seem to be down, so i think this must be at least commented (actual state) or removed.

I don't think it's good to maintain that feature by current members because of less time. It's so nice if you write testing step(pull branch, build, run...), though I have intended to do it.

Also in file source/organization/contributors.html.md it is still Ana which is mentionned as principal contact to be added, but maybe it must be replaced by KitaitiMakoto now ?

Yep, I will add it myself. You can leave the page not touched.

Thank you for great pull request. Especially Caddyfile modification is so helpful. > In source/contribute/code-review.html.md there is mention of websites https://pr-list.joinplu.me and https://pr-XXX.joinplu.me but they seem to be down, so i think this must be at least commented (actual state) or removed. I don't think it's good to maintain that feature by current members because of less time. It's so nice if you write testing step(pull branch, build, run...), though I have intended to do it. > Also in file source/organization/contributors.html.md it is still Ana which is mentionned as principal contact to be added, but maybe it must be replaced by KitaitiMakoto now ? Yep, I will add it myself. You can leave the page not touched.

Marius commented

2020-12-06 15:35:20 +00:00

I revert the changes for contributors.html.md and add a TODO in the test section to document it, however i do not know if i could do it myself (Not sure of my install actually).

Would you that i did it in this PR, or we close it and let another pr do the job of documenting the testing section ?

I revert the changes for *contributors.html.md* and add a TODO in the test section to document it, however i do not know if i could do it myself (Not sure of my install actually). Would you that i did it in this PR, or we close it and let another pr do the job of documenting the testing section ?

KitaitiMakoto commented

2020-12-06 15:41:43 +00:00

@Marius Thank you for rewriting.

You may leave the testing section as it is. But you seem write contributors to code review page... Can you fix it?

@Marius Thank you for rewriting. You may leave the testing section as it is. But you seem write contributors to code review page... Can you fix it?

Marius commented

2020-12-06 18:05:05 +00:00

I finally fix it !(i take time to battle with git commands).

So the PR is ready i remove the wip.

I finally fix it !(i take time to battle with git commands). So the PR is ready i remove the wip.

Marius changed title from ~~WIP: doc-typo~~ to doc-typo

2020-12-06 18:05:14 +00:00

KitaitiMakoto approved these changes 2020-12-06 22:53:24 +00:00

KitaitiMakoto left a comment

@Marius Nice! Will merge. Thank you!

source/installation/with/prebuilt.html.md

					
				@ -10,3 +10,3 @@

				To download and install the latest release, first define the following variable in your shell:

				- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP or `sqlite` in the file name. Choose which you want.

				- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP` or `sqlite` in the file name. Choose which you want.

KitaitiMakoto commented

2020-12-06 06:04:37 +00:00

It' my fault. But could you remove trailing "P" from postgresP?

It' my fault. But could you remove trailing "P" from `postgresP`?

source/organization/contributors.html.md Outdated

					
				@ -70,3 +70,3 @@

				You can either [do it by yourself](https://git.joinplu.me/plume/documentation/_edit/main/source/organization/contributors.html.md)

				if you have a Gitea account, or give Ana all the required informations and she will add you (see above for contact information).

				if you have a Gitea account, or give Ana/KitaitiMakoto all the required informations and she/he will add you (see above for contact information).

KitaitiMakoto commented

2020-12-06 06:07:08 +00:00

I missed out this sentence. Can you leave only KitaitiMakoto and he?

I missed out this sentence. Can you leave only `KitaitiMakoto` and `he`?

source/update/prebuilt.html.md

					
				@ -7,3 +7,3 @@

				You'll need to define a variable in your shell first:

				- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP or `sqlite` in the file name. Choose which you want.

				- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP` or `sqlite` in the file name. Choose which you want.