Monitor stage technical writer onboarding for Amy Qualls
Trainee technical writer: @aqualls
Existing technical writer: @axil
Trainee milestone: 12.9
Reassignment milestone (on day 1): 12.10
Intro
-
Existing TW: Invite the trainee to the stage Slack channel. Post there letting the stage know about the trainee status/milestone, that you're still the go-to for this milestone while they get ramped up (but they will engage on a variety of MRs), and that the trainee is scheduled to be assigned to all groups of the stage for the subsequent milestone. :wave::skin-tone-2: Hi awesome people of the Monitor team, a small announcement! As the Technical Writing team expands, we are changing assignments to the various stages and groups. For the 12.9 cycle, @Amy Qualls will be the trainee Technical Writer assigned to Monitor. You probably already know this from a previous message, and since she has already jumped on many issues, merge requests and calls, but this is kind of the official announcement :stuck_out_tongue: Anyway, she will be shadowing me on all issues and MRs for 12.8 and 12.9, and from the 12.10 cycle, Amy will take over as the primary Technical Writer for Monitor. That will free me up to take up responsibility for other groups and stages that I'm already assigned to. We maintain a table with all the reassignments if you want to take a look https://docs.google.com/spreadsheets/d/1vrCG7N9d9XxKAR46xmu8axLaubZw9ESmzVkLyGotteQ/edit#gid=0 It's been a fun ride :slightly_smiling_face: Cheers!
-
Existing TW: Ensure each PM and EM are aware of the changes and ask them for recommendations on meetings the TW should attend, other resources to monitor, on getting to know the stage/group(s) features and any other prerequisite knowledge (perhaps mirroring this aspect of engineer onboarding - e.g. certain videos or tasks within GitLab), and any other suggestions. Enter those details here, in this issue under Further resources or tasks.
Learn
-
Visit https://about.gitlab.com/handbook/product/categories/#devops-stages and find the group(s). -
Find the listed engineering managers (frontend and backend) on the Org Chart and set up coffee chats with some members of their teams. -
Read the linked Handbook pages and Strategy pages. -
Read the linked top-level doc pages, but also go to https://about.gitlab.com/features/ and follow the Documentation links for each feature page. -
Other than the linked docs, go to https://about.gitlab.com/features/ and review the Documentation links for every feature.
Note: These are not separated by group. To identify the group, you'll need to look up the feature in the source of this page https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/features.yml and identify its category, then identify which group the category belongs to. (Remember, the hierarchy is Section > Stage > Group > Category > Feature. Group:category relationships are listed here.)
-
Pages for 'metrics' feature:
-
https://about.gitlab.com/devops-tools/new-relic/ -
https://about.gitlab.com/devops-tools/datadog/ -
https://about.gitlab.com/devops-tools/splunk/ -
https://about.gitlab.com/devops-tools/micro-focus-apm/ -
https://about.gitlab.com/devops-tools/dynatrace/ -
https://about.gitlab.com/devops-tools/broadcom-apm/i -
https://about.gitlab.com/devops-tools/nagios/ -
https://about.gitlab.com/devops-tools/azuremonitor/ -
https://docs.gitlab.com/ee/user/project/integrations/prometheus.html -
https://docs.gitlab.com/ee/administration/monitoring/prometheus/index.html
Pages for 'logging' feature:
-
https://docs.gitlab.com/ee/administration/logs.html -
https://docs.gitlab.com/omnibus/settings/logs.html#udp-log-forwarding -
https://docs.gitlab.com/ee/administration/audit_events.html -
https://docs.gitlab.com/ee/user/project/clusters/kubernetes_pod_logs.html
Pages for 'Incident management' feature:
-
https://about.gitlab.com/devops-tools/victorops/ -
https://docs.gitlab.com/ee/user/project/integrations/prometheus.html#taking-action-on-incidents-ultimate -
https://docs.gitlab.com/ee/user/project/integrations/prometheus.html#embedding-metric-charts-within-gitlab-flavored-markdown
Pages for other features:
-
Tracing: https://docs.gitlab.com/ee/user/project/operations/tracing.html -
Error tracking: https://docs.gitlab.com/ee/user/project/operations/error_tracking.html -
Cluster monitoring: https://docs.gitlab.com/ee/user/project/clusters/#monitoring-your-kubernetes-cluster-ultimate
Further resources or tasks
Amy has reached out to @kbychu, who suggested she reach out to @dhershkovitch and @sarahwaldner. Kevin said there was a weekly APM and Health meeting that they lead, and I should attend.
For gaining access to a test / demo version of the product, Kevin recommended this google link to Amy.
Log
Issues assigned or involved
- Duplicate Alerting sections on user Incident Management doc page gitlab#199710 (closed)
- Add Thanos support for our documentation gitlab#201052 (closed)
Issues created
MRs assigned or involved
- Add documentation related to modSecurity as supported by auto-deploy-app gitlab!24024 (merged)
- Add documentation for column panel types gitlab!23907 (merged)
- Remove duplicated information from alerting page gitlab!24115 (merged)
- Release Post - Monitor:APM - Log Explorer gitlab-com/www-gitlab-com!38163 (merged)
- Document how to enable/disable self monitoring project gitlab!24497 (merged)
- Docs: Expand config subheading to add Thanos gitlab!24543 (merged)
- Add documentation for stacked column charts gitlab!24020 (merged)
- Fix release version for full text search docs gitlab!24646 (merged)
- Monitor Health Release Post 12.8 - Option to collapse unfurled charts in issues gitlab-com/www-gitlab-com!40768 (merged)
- Release post - APM - Update release post with Column gitlab-com/www-gitlab-com!40773 (merged)
- Release post - APM - Update environment dropdown gitlab-com/www-gitlab-com!40753 (merged)
- Release post - APM - Drill to log explorer from metric chart gitlab-com/www-gitlab-com!40789 (merged)
- Monitor health release post 12.8 - close gitlab issues on sentry error resolve gitlab-com/www-gitlab-com!40763 (merged)
- Add documentation for single stat percentile value support gitlab!24816 (merged)
- Release post- APM- self monitoring project gitlab-com/www-gitlab-com!40827 (merged)
- Add documentation for logs times ranges gitlab!24758 (merged)
- Add mention of closing issues after error resolve gitlab!24823 (merged)
- Monitor Health Release Post 12.8- filter error list gitlab-com/www-gitlab-com!40762 (merged)
- Doc update monitoring dashboard gitlab!24929 (merged)
- Introduce visibility toggle in the project settings section gitlab#204913
- Document GITLAB_TRACING distributed tracing configuration gitlab#26626 (closed)
- Add links to monitoring GitLab.com to perf docs gitlab!25074 (merged)
- Update y axis range documentation gitlab!25230 (merged)
- Add info to migration style guide on reversibility gitlab!25098 (merged)
- Automatically include metrics embed for gitlab alerts gitlab!25277 (merged)
- Cluster Embed Metric Dashboard Endpoint gitlab!25739 (merged)
- WIP: Release Post for WAF Controls gitlab-com/www-gitlab-com!42138 (merged)
- Add instructions to run pipeline on GDK https://gitlab.com/gitlab-org/monitor/tanuki-inc/-/merge_requests/9
- Update charts documentation and common_metrics.yml to match gitlab!26048 (merged)
- WIP: Add infinite scrolling to logs gitlab!26254 (merged)
- Use create/delete words in self-monitoring docs gitlab!26590 (merged)
- Add very basic repo mirror documents using the pull method status-page!20 (merged)
MRs created
- Style fixes to feature pages while doing the big readthrough:
- Grammar and style fixes in devops pages gitlab-com/www-gitlab-com!41552 (merged)
- Docs: fix grammar and spelling on DataDog page gitlab-com/www-gitlab-com!41547 (merged)
- Grammar and style fixes for Prometheus page gitlab!25567 (merged)
- Docs: major style fixes for logs page gitlab!25574 (merged)
- Style fixes for audit events page gitlab!25576 (merged)
- Style fixes to the Kubernetes pod log page gitlab!25577 (merged)
- Docs: fix spelling and typos on VictorOps page gitlab-com/www-gitlab-com!41589 (merged)