clean-up docs to avoid version-mismatches in BE and FE in new installs (for develop)

stefan230 commented

2022-12-16 16:33:47 +00:00

Contributor

I fixed up the documentation a little bit so it should take care that both BE and FE are installed in their correct and matching versions from the respective development-branches, when akkoma is installed from source using git.

This should avoid problems with new installations from git running develop-BE, but running but running Pleroma-FE in stable, which might result in some issues when upgrading and a breaking change is made in develop-BE that is not yet accounted for in stable-FE.

I fixed up the documentation a little bit so it should take care that both BE and FE are installed in their correct and matching versions from the respective development-branches, when akkoma is installed from source using git. This should avoid problems with new installations from git running develop-BE, but running but running Pleroma-FE in stable, which might result in some issues when upgrading and a breaking change is made in develop-BE that is not yet accounted for in stable-FE.

stefan230 added 1 commit 2022-12-16 16:33:47 +00:00

clean-up docs to avoid mismatches in BE and FE. Clearly state that development-versions are installed

ci/woodpecker/pr/woodpecker Pipeline is pending

Details

69149d9290

floatingghost commented

2022-12-19 11:01:15 +00:00

Owner

ah right this will cause rather unfun merge conflicts with stable when develop gets merged into stable - we should probably recommend stable across all docs

or if we wanted to be really cute about things we could use tags? i already tag releases when i do them, so we could recommend checking out the latest tag instead of a stable branch?

ah right this will cause rather unfun merge conflicts with stable when develop gets merged into stable - we should probably recommend `stable` across all docs or if we wanted to be really cute about things we could use tags? i already tag releases when i do them, so we could recommend checking out the latest tag instead of a stable branch?

floatingghost commented

2022-12-19 12:22:21 +00:00

Owner

https://meta.akkoma.dev/t/akkoma-stable-2022-12-automatic-static/225#from-source-9 for the "checkout out a tag" thingy

stefan230 commented

2022-12-19 12:50:29 +00:00

Author

Contributor

🤔 I am thinking about how much sense there is right now to merge this right now for the develop-docs. Certainly we have some mismatches in the develop-documents still where it says to install stable FE on a develop frontend.

On the other hand I am reworking the documentation a bit from a structural standpoint right now, see this thread: https://meta.akkoma.dev/t/rework-of-documentation/256

So I don't how relevant this will be. Adding the line where the lastest (stable) version is checked out should be fine.

If I understand you correctly you want the people to always install stable (so basically a numbered version) from now?

Then I think there is no need for two different branches of the documentation or do I overlook something?

One could also think about merging the whole documentation into one thingie or something. So instead of having https://docs.akkoma.dev/stable and https://docs.akkoma.dev/develop one could use just one documentation version on https://docs.akkoma.dev/, which defaults to stable and have a dedicated section for devs like we have under https://docs.akkoma.dev/stable/development/?

I am sorry if this comes across as confusing. I did my best explaning. basically having two different docs on two branches is bound to lead to problems really.

🤔 I am thinking about how much sense there is right now to merge this right now for the develop-docs. Certainly we have some mismatches in the develop-documents still where it says to install stable FE on a develop frontend. On the other hand I am reworking the documentation a bit from a structural standpoint right now, see this thread: https://meta.akkoma.dev/t/rework-of-documentation/256 So I don't how relevant this will be. Adding the line where the lastest (stable) version is checked out should be fine. If I understand you correctly you want the people to always install stable (so basically a numbered version) from now? Then I think there is no need for two different branches of the documentation or do I overlook something? One could also think about merging the whole documentation into one thingie or something. So instead of having https://docs.akkoma.dev/stable and https://docs.akkoma.dev/develop one could use just one documentation version on https://docs.akkoma.dev/, which defaults to stable and have a dedicated section for devs like we have under https://docs.akkoma.dev/stable/development/? I am sorry if this comes across as confusing. I did my best explaning. basically having two different docs on two branches is bound to lead to problems really.

floatingghost commented

2022-12-19 12:55:58 +00:00

Owner

Then I think there is no need for two different branches of the documentation or do I overlook something?

yeah you missed something - stable is basically just a snapshot of development, development will get merged into stable once a month, so differences get overwritten

but yes going forward it'll make more sense to check out numbered releases instead of having to do the whole merge dance - i'll deprecate the branch next release, and remove it one after that

>Then I think there is no need for two different branches of the documentation or do I overlook something? yeah you missed something - stable is basically just a snapshot of development, development will get merged into stable once a month, so differences get overwritten but yes going forward it'll make more sense to check out numbered releases instead of having to do the whole merge dance - i'll deprecate the branch next release, and remove it one after that

stefan230 commented

2022-12-19 13:05:17 +00:00

Author

Contributor

So what would be the best cause of action for the docs then? I was using the develop-branch for my rework of course. I would update the rework accordingly so numbered releases are used instead for BE then.

Also if I understand correctly you will deprecate and remove the stable branch, since "stable" is numbered releases now anyway?

Also will pleroma-fe stay the same as is now (in terms of there being two branches)? Or do you think a tagged release might be useful there as well?

So what would be the best cause of action for the docs then? I was using the develop-branch for my rework of course. I would update the rework accordingly so numbered releases are used instead for BE then. Also if I understand correctly you will deprecate and remove the stable branch, since "stable" is numbered releases now anyway? Also will pleroma-fe stay the same as is now (in terms of there being two branches)? Or do you think a tagged release might be useful there as well?

floatingghost commented

2022-12-29 15:44:42 +00:00

Owner

stable merged back into develop via 11ec4e1b8f

also, no need for tagged releases in pleroma-fe, since we use an internal update mechanism anyhow (via the frontend.install thingy)

stable merged back into develop via https://akkoma.dev/AkkomaGang/akkoma/commit/11ec4e1b8f596f67713e94171832fb01e0bc15db also, no need for tagged releases in pleroma-fe, since we use an internal update mechanism anyhow (via the frontend.install thingy)

stefan230 closed this pull request

2024-02-17 21:53:42 +00:00

ci/woodpecker/pr/woodpecker Pipeline is pending

Details

Pull request closed

This pull request cannot be reopened because the branch was deleted.

clean-up docs to avoid version-mismatches in BE and FE in new installs (for develop) #377

Pull request closed