Docs for Trusted Committers

[spier]

There are a couple of things about the way that we maintain this repo that we have not documented yet. I think that most, if not all of them, are about how we host our patterns in gitbook.

We should document all of them, so that all Trusted Committers (TC) can work independently on this repo.

Things that need further documentation:

• the gitbook setup (incl how to give access to gitbook for further TCs)
• Google Analytics setup (incl how to give access to gitbook for further TCs)
• DNS config for gitbook (dependency to others in the ISC)

[spier]

@yuhattor and @robtuley, you were the last TCs that we added to this repo. Where would you expect to find documentation for the things listed above?

Also we don't have any private documentation just for TCs. I guess we would have to write up all of these things in such a way that we can keep them in this repo and that anybody can read them? i.e. no confidential info/passwords or similar.

[spier]

Onboarding a new TC to gitbook:

• admins that can invite new users are @lenucksi, @dicortazar and @spier
• invite new users by email address (they need to create a gitbook account)
• give them the role "Creator" (assuming that they want to create new books)
• if they publish their new gitbook from a repo within the InnerSourceCommons org (which is likely and also desireable): ask one of our GitHub org Owners to give the gitbook app access to the repo

[spier]

Onboarding for Google Analytics:

• admins that can invite new users are: @spier
• invite new users by email address (needs a gmail account?)
• under "View Access Management" assign the role "Editor" to the new user

TODO:

• make all TCs admins, so that they can add new users etc?

[lenucksi]

Sounds like this could end up in a nice Markdown file once everything is collected. As a follow-up: Did Google not change to another Analytics platform that killed all the old setups? Are there other more GDPR friendly things than Google Analytics? (Plausible Analytics etc.)

[spier]

Sounds like this could end up in a nice Markdown file once everything is collected.

Yes, that's the plan 👍

As a follow-up: Did Google not change to another Analytics platform that killed all the old setups?

True. We do have some time though.

The info I have is this: "On July 1, 2023, Universal Analytics will stop processing new hits." So yes, at some point we need to move to something else, or stop tracking usage entirely.

Are there other more GDPR friendly things than Google Analytics? (Plausible Analytics etc.)

I have no experience with anything else but if you do, maybe you could try it out?

Below the overview of alternative Analytics Integrations that gitbook supports. Looks like Plausible is possible as well. If you decide to work on this, could you break this out into a new issue/PR?

[spier]

We can take inspiration for this documentation from here: https://github.com/InnerSourceCommons/InnerSourceLearningPath/blob/main/docs/adding-trusted-committers.md