Skip to content

Commit 443cfc8

Browse files
committed
Documentation Updates
Why these changes are being introduced: All Infra-related repositories need a CODEOWNERS file and additional sections in the README to ensure that the links between repositories are clearly documented. How this addresses that need: * Create a CODEOWNERS file * Add a Related Assets section and a Maintainers section to the README Side effects of this change: None.
1 parent 86bac29 commit 443cfc8

File tree

2 files changed

+31
-3
lines changed

2 files changed

+31
-3
lines changed

.github/CODEOWNERS

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# CODEOWNERS file (from GitHub template at
2+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
3+
# Each line is a file pattern followed by one or more owners.
4+
5+
################################################################################
6+
# These owners will be the default owners for everything in the repo. Unless a
7+
# later match takes precedence, @cabutlermit will be requested for review when
8+
# someone opens a pull request.This is commented out in favor of using a team
9+
# as the default (see below). It is left here as a comment to indicate the
10+
# primary expert for this code.
11+
# * @cabutlermit
12+
13+
# Teams can be specified as code owners as well. Teams should be identified in
14+
# the format @org/team-name. Teams must have explicit write access to the
15+
# repository.
16+
* @mitlibraries/infraeng-terraform-reviewers
17+
18+
# We set the senior engineer in the team as the owner of the CODEOWNERS file as
19+
# a layer of protection for unauthorized changes.
20+
/.github/CODEOWNERS @cabutlermit

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,15 @@ Matomo has built-in two-factor authentication, which we enforce for all accounts
8989

9090
See the official [Recover from lost 2FA](https://matomo.org/faq/how-to/faq_27248) documentation. This allows us to recover the Superuser login if we lose the 2FA information.
9191

92-
## Additional documentation
92+
## Related Assets
9393

94-
* [MIT Libraries dev docs](https://mitlibraries.github.io/guides/misc/matomo.html) - includes information about setting up a website for tracking in Matomo.
95-
* [Matomo help center](https://matomo.org/help/) - offical Matomo docs. Includes user guide, developer guide, FAQ, and community support forum.
94+
* Infrastructure: [mitlib-tf-workloads-matomo](https://github.com/MITLibraries/mitlib-tf-workloads-matomo)
95+
96+
## Maintainers
97+
98+
* Owner: See [CODEOWNERS](./.github/CODEOWNERS)
99+
* Team: See [CODEOWNERS](./.github/CODEOWNERS)
100+
* Last Maintenance: 2025-02
101+
* External Documentation:
102+
* [MIT Libraries dev docs](https://mitlibraries.github.io/guides/misc/matomo.html) - includes information about setting up a website for tracking in Matomo.
103+
* [Matomo help center](https://matomo.org/help/) - offical Matomo docs. Includes user guide, developer guide, FAQ, and community support forum.

0 commit comments

Comments
 (0)