Update Pleroma references in documentation

norm commented

2022-07-02 16:22:42 +00:00

Contributor

Many of the install guides still refer to the Pleroma repo and the like.

To-do:

Documentation
- Index
- Installation
- Development
- Configuration
- Administration
Sample config files in installation directory

Many of the install guides still refer to the Pleroma repo and the like. To-do: - [x] Documentation - [x] Index - [x] Installation - [x] Development - [x] Configuration - [x] Administration - [x] Sample config files in `installation` directory

norm commented

2022-07-02 16:23:43 +00:00

Author

Contributor

One thing I'm wondering is that there's refences to Pleroma's IRC channel for support. What's the best way to handle this sort of thing?

norm commented

2022-07-02 18:07:26 +00:00

Author

Contributor

Also should the sample config files be updated as well?

floatingghost commented

2022-07-02 19:12:04 +00:00

Owner

we don't really have any sort of irc support, so i guess for now it can just be cut out?

by sample config? if it links to the git repo just for reference then i guess we redirect them here, but there are some references to repos actually needed (like emoji stuff) which isn't migrated here yet

we don't really have any sort of irc support, so i guess for now it can just be cut out? by sample config? if it links to the git repo just for reference then i guess we redirect them here, but there are some references to repos actually needed (like emoji stuff) which isn't migrated here yet

👍 1

norm commented

2022-07-02 19:25:15 +00:00

Author

Contributor

I was wondering if it's okay to change the pleroma user to akkoma in the docs or should that be kept as is?

I was wondering if it's okay to change the `pleroma` user to `akkoma` in the docs or should that be kept as is?

norm referenced this issue

2022-07-02 20:31:46 +00:00

Update install docs #38

norm referenced this issue

2022-07-02 21:40:58 +00:00

Update administration docs #39

norm referenced this issue

2022-07-03 03:49:17 +00:00

Update configuration docs #40

norm referenced this issue

2022-07-04 02:36:29 +00:00

Update development docs #43

Ghost commented

2022-07-04 13:40:46 +00:00

should akkoma's docs even reference pleroma-fe? from what I understand one of the main points of this fork is to make any frontend able to be the "main one" (which is also why I don't think our pleroma-fe should be rebranded to akkoma-fe)

imo the extensive docs should be removed and replaced with a link to docs-develop, with a reference to akkoma's soft fork of pleroma-fe as well.

should akkoma's docs even reference pleroma-fe? from what I understand one of the main points of this fork is to make any frontend able to be the "main one" (which is also why I don't think our pleroma-fe should be rebranded to akkoma-fe) imo the extensive docs should be removed and replaced with a link to docs-develop, with a reference to akkoma's soft fork of pleroma-fe as well.

floatingghost commented

2022-07-04 16:40:01 +00:00

Owner

yeah, when i fully disconnect pleroma-fe (coming soon (tm)) it'll probably be a good idea to remove the links from the docs, but until then i guess they'll stay

norm referenced this issue

2022-07-05 11:12:36 +00:00

Update sample config files #48

Ghost commented

2022-07-06 06:43:08 +00:00

Hi, I'm not sure if this belongs here or to a separate ticket, but there are also a lot of references to Pleroma in environment variables, PostgreSQL user, etc. For example, my instance wouldn't start until I symlinked /etc/akkoma to /etc/pleroma as it would otherwise complain about missing PLEROMA_CONFIG_PATH.

I think I could take a shot at this, but what is your stance on what pleromas should be changed to akkomas?

Hi, I'm not sure if this belongs here or to a separate ticket, but there are also a lot of references to Pleroma in environment variables, PostgreSQL user, etc. For example, my instance wouldn't start until I symlinked `/etc/akkoma` to `/etc/pleroma` as it would otherwise complain about missing `PLEROMA_CONFIG_PATH`. I think I could take a shot at this, but what is your stance on what pleromas should be changed to akkomas?

Ghost commented

2022-07-06 10:33:43 +00:00

this would break a lot of existing installations and renaming every folder and user is a hassle, so unless you could write a script that automates it i think it should be at at least kept as a fallback

this would break a *lot* of existing installations and renaming every folder and user is a hassle, so unless you could write a script that automates it i think it should be at at least kept as a fallback

norm commented

2022-07-06 11:48:24 +00:00

Author

Contributor

@mjmrotek does this fix the issue for you? 271e08fa48

@mjmrotek does this fix the issue for you? https://akkoma.dev/AkkomaGang/akkoma/commit/271e08fa48a02900f12a72e4cacc8c04e2d34419

norm commented

2022-07-06 11:51:44 +00:00

Author

Contributor

Perhaps I could make the changes to lib/pleroma/config/release_runtime_provider.ex in #48 be a separate PR.

Perhaps I could make the changes to `lib/pleroma/config/release_runtime_provider.ex` in https://akkoma.dev/AkkomaGang/akkoma/pulls/48 be a separate PR.

norm referenced this issue

2022-07-06 11:59:03 +00:00

Fix config path lookup #51

Ghost commented

2022-07-06 16:30:46 +00:00

this would break a lot of existing installations and renaming every folder and user is a hassle, so unless you could write a script that automates it i think it should be at at least kept as a fallback

Ok, it's just that some instructions from https://docs.akkoma.dev/main/backend/installation/otp_en/ don't work because of things named "akkoma" in the docs and "pleroma" in the actual downloaded files, for example /opt/akkoma/installation/akkoma.nginx is actually /opt/akkoma/installation/pleroma.nginx, same for /opt/akkoma/installation/init.d/akkoma.

@mjmrotek does this fix the issue for you? 271e08fa48

Thanks, I'll try. The symlink hack worked for me though, so it wasn't a pressing issue, just something that confused me during installation. I also had a leftover Pleroma files on the same server, so initially Akkoma worked but was reading the Pleroma config while I didn't notice.

> > this would break a *lot* of existing installations and renaming every folder and user is a hassle, so unless you could write a script that automates it i think it should be at at least kept as a fallback Ok, it's just that some instructions from https://docs.akkoma.dev/main/backend/installation/otp_en/ don't work because of things named "akkoma" in the docs and "pleroma" in the actual downloaded files, for example `/opt/akkoma/installation/akkoma.nginx` is actually `/opt/akkoma/installation/pleroma.nginx`, same for `/opt/akkoma/installation/init.d/akkoma`. > @mjmrotek does this fix the issue for you? https://akkoma.dev/AkkomaGang/akkoma/commit/271e08fa48a02900f12a72e4cacc8c04e2d34419 Thanks, I'll try. The symlink hack worked for me though, so it wasn't a pressing issue, just something that confused me during installation. I also had a leftover Pleroma files on the same server, so initially Akkoma worked but was reading the Pleroma config while I didn't notice.

norm commented

2022-07-06 18:56:29 +00:00

Author

Contributor

Ok, it's just that some instructions from https://docs.akkoma.dev/main/backend/installation/otp_en/ don't work because of things named "akkoma" in the docs and "pleroma" in the actual downloaded files, for example /opt/akkoma/installation/akkoma.nginx is actually /opt/akkoma/installation/pleroma.nginx, same for /opt/akkoma/installation/init.d/akkoma.

Should be fixed in #48 which was merged just now.

this would break a lot of existing installations and renaming every folder and user is a hassle, so unless you could write a script that automates it i think it should be at at least kept as a fallback

I think the only hardcoded path in the actual Pleroma code that needed to be changed was in lib/pleroma/config/release_runtime_provider.ex which was fixed in #51 (with a fallback to the old path).

@floatingghost @sfr okay to close now?

> Ok, it's just that some instructions from https://docs.akkoma.dev/main/backend/installation/otp_en/ don't work because of things named "akkoma" in the docs and "pleroma" in the actual downloaded files, for example /opt/akkoma/installation/akkoma.nginx is actually /opt/akkoma/installation/pleroma.nginx, same for /opt/akkoma/installation/init.d/akkoma. Should be fixed in #48 which was merged just now. > this would break a lot of existing installations and renaming every folder and user is a hassle, so unless you could write a script that automates it i think it should be at at least kept as a fallback I think the only hardcoded path in the actual Pleroma code that needed to be changed was in `lib/pleroma/config/release_runtime_provider.ex` which was fixed in #51 (with a fallback to the old path). @floatingghost @sfr okay to close now?

floatingghost commented

2022-07-06 18:59:13 +00:00

Owner

seems good to me, thanks for all the work, it helps a lot

floatingghost closed this issue

2022-07-06 18:59:16 +00:00

Update Pleroma references in documentation #36