Introduction
We (the documentation squad) are part of the ACM team and are responsible for documenting Red Hat Advanced Cluster Management for Kubernetes. We also work on a variety of other tasks, such as reviewing and editing technical blogs, reviewing UI content with designers, and resolving bugs and issues by using agile scrum techniques. We use the Documentation component as an identifier on Jira and work closely with developers to maintain the documentation.
Important: See the ACM Playbook for details about how to work as part of the ACM team. The ACM Playbook also includes the link to a general onboarding guide. This website primarily serves as internal documentation for the documentation squad. It outlines our work processes and standards. However, other ACM team members and contributors might find the resources and information listed on this website useful as well.
Hardware
Ask your manager or team members about the hardware we use. You can also ask about hardware options for your assigned desk, if you have one. When choosing a computer, remember that we can only help you with systems we are familiar with. You can also consult with IT, keeping in mind that they can only help you with approved hardware that they provide.
Required software
See the following list of required software and tools. Let your manager know if you have troubles installing any of these:
Visual Studio Code
The primary code editor we use. Alternatively, you can also use VSCodium to avoid sending telemetry data to Microsoft.
Slack
The primary messaging software we use.
Homebrew
A package manager for macOS that we use to install and manage other tools.
Git
The control system we use to maintain our GitHub repository.
gsed
The stream editor we use to build our documentation.
Permissions
Accessing some of our tools and processes requires specific permissions. As you follow various instructions on this website, reach out to your manager whenever you run into permission issues.
Next steps
When you are ready, familiarize yourself with our standards and processes by reading the following topics: