coop-cloud/organising
coop-cloud
/
organising
7
0
Fork 0
Code Issues 156 Pull Requests Projects 2 Releases Activity

Improve the operators tutorial #537

New Issue
Open
opened 2023-11-23 12:34:53 +00:00 by decentral1se · 9 comments
decentral1se commented 2023-11-23 12:34:53 +00:00
Owner
Copy Link

Comrades, the docs are out of sync, we need to catch up on this and get it in order.

Updating: we want to just fix the operators tutorial because that is really so important. Reducing scope.

/cc @knoflook

~~Comrades, the docs are out of sync, we need to catch up on this and get it in order.~~ Updating: we want to just fix the operators tutorial because that is really so important. Reducing scope. /cc @knoflook
decentral1se added the
bug
 label 2023-11-23 12:34:53 +00:00
decentral1se changed title from DOCS SPRINT to Fix the operators tutorial 2023-11-23 12:38:19 +00:00
decentral1se changed title from Fix the operators tutorial to Improve the operators tutorial 2023-11-23 12:39:10 +00:00
knoflook commented 2023-11-23 12:39:57 +00:00
Owner
Copy Link

@wykwit

@wykwit
p4u1 commented 2024-01-08 14:48:27 +00:00
Member
Copy Link

@decentral1se Can you give an example of what is out of date in the operators tutorial?

Should we go over every abra commit since the last documentation and check if it got included in the documentation (if applicable)

@decentral1se Can you give an example of what is out of date in the operators tutorial? Should we go over every abra commit since the last documentation and check if it got included in the documentation (if applicable)
decentral1se commented 2024-01-08 14:59:51 +00:00
Author
Owner
Copy Link

@knoflook had some strong opinions on what to change, I was just opening the ticket to support.

Let's see what they come back with on this. Will ping on the matrix chat as well.

@knoflook had some strong opinions on what to change, I was just opening the ticket to support. Let's see what they come back with on this. Will ping on the matrix chat as well.
👍 1
basebuilder self-assigned this 2024-01-27 11:35:18 +00:00
basebuilder commented 2024-01-27 11:36:35 +00:00
Member
Copy Link

I chatted with @knoflook yesterday and got a bit more synchronized up. This coming week I will walk myself Operator and Maintainer tutorials and make notes, ask questions, and work to improve these docs 😃

I chatted with @knoflook yesterday and got a bit more synchronized up. This coming week I will walk myself Operator and Maintainer tutorials and make notes, ask questions, and work to improve these docs 😃
❤️ 2
decentral1se commented 2024-01-28 10:16:32 +00:00
Author
Owner
Copy Link

Great folks! To remind, we have 3-8 hours budget'd for this in https://docs.coopcloud.tech/federation/resolutions/passed/014/ - you may want to check in with the others marked as implementors of this resolution to see what hours are left over. You could do that on the chat. Maybe you have more to spend on it.

Great folks! To remind, we have 3-8 hours budget'd for this in https://docs.coopcloud.tech/federation/resolutions/passed/014/ - you may want to check in with the others marked as implementors of this resolution to see what hours are left over. You could do that on the chat. Maybe you have more to spend on it.
👍 1
einarpersson commented 2024-01-30 20:18:57 +00:00
Copy Link

Hi!

I visited your matrix chat a week ago and had some docs issues / suggestions, and was encouraged to post them here, so I did:

#560
#561
#562
#563

Hi! I visited your matrix chat a week ago and had some docs issues / suggestions, and was encouraged to post them here, so I did: https://git.coopcloud.tech/coop-cloud/organising/issues/560 https://git.coopcloud.tech/coop-cloud/organising/issues/561 https://git.coopcloud.tech/coop-cloud/organising/issues/562 https://git.coopcloud.tech/coop-cloud/organising/issues/563
👍 1 🎉 2
basebuilder added the
documentation
 label 2024-01-30 20:47:37 +00:00
basebuilder commented 2024-01-30 20:49:12 +00:00
Member
Copy Link

@einarpersson hey there, thanks for documenting this 👍 I'll definitely address these issues in docs reworking!!

@einarpersson hey there, thanks for documenting this 👍 I'll definitely address these issues in docs reworking!!
decentral1se commented 2024-01-31 07:56:50 +00:00
Author
Owner
Copy Link

Amazing @einarpersson, tysm!

Amazing @einarpersson, tysm!
basebuilder commented 2024-02-11 16:57:26 +00:00
Member
Copy Link

Various questions and minor improvements to the Docs as I go through the steps multiple times which I find myself asking:

  1. Add section at top that shows a tree of ~/.abra dir and give minor overview of it
  2. Add starting docker to steps systemctl start docker.service
  3. Is this to be run as root or non-root user docker swarm init ?
  4. Show successful CLI output abra servers add
  5. Show successful CLI output abra servers ls
  6. More details and links around abra app config <traefik-domain> step
  7. Inspecting things generated by the -S command in nextcloud.domain.org doesn't match what's expected from the docs
  8. Clarify --secrets and config ..._VERSION=v1 values such as SECRET_DB_PASSWORD_VERSION=v1 mean
Various questions and minor improvements to the Docs as I go through the steps multiple times which I find myself asking: 0. [ ] Add section at top that shows a `tree` of `~/.abra` dir and give minor overview of it 1. [ ] Add starting docker to steps `systemctl start docker.service ` 2. [ ] Is this to be run as root or non-root user `docker swarm init` ? 3. [ ] Show successful CLI output `abra servers add` 4. [ ] Show successful CLI output `abra servers ls` 5. [ ] More details and links around `abra app config <traefik-domain>` step 6. [ ]Inspecting things generated by the `-S` command in `nextcloud.domain.org` doesn't match what's expected from the docs 7. [ ] Clarify `--secrets` and config `..._VERSION=v1` values such as `SECRET_DB_PASSWORD_VERSION=v1` mean
👍 2
decentral1se removed the
bug
 label 2024-03-27 06:22:20 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
master
Labels
Clear labels   
abra

Everything to do with abra

  
abra-gandi

Abra Gandi plugin

  
awaiting-feedback

Ping/pong on comms

  
backups

   
bug

Something is not working

  
build

Go build related issues

  
ci/cd

Getting the robots into the mix

  
community organising

Opening this thing up

  
contributing

Contributors stuff

  
coopcloud.tech

Our main website

  
democracy

Democratic decision making

  
design

Design thinking required

  
documentation

Let's write things together

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
finance

Money things

  
funding

Anything related to grant funding

  
good first issue

Easy start with development

  
help wanted

Need some help

  
installer

Installation related issues

  
kadabra

   
performance

Performance related

  
proposal

Large change which requires feedback & decisin making

  
question

More information is needed

  
recipes.coopcloud.tech

Our recipes catalogue

  
security

Securing our shit

  
test

Unit or integration test suite

  
wontfix

This won't be fixed

No Label
abra
abra-gandi
awaiting-feedback
backups
bug
build
ci/cd
community organising
contributing
coopcloud.tech
democracy
design
documentation
duplicate
enhancement
finance
funding
good first issue
help wanted
installer
kadabra
performance
proposal
question
recipes.coopcloud.tech
security
test
wontfix
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
basebuilder
5 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: coop-cloud/organising#537
No description provided.
Delete Branch "%!s(<nil>)"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?