Open source your repository: a roadmap
333 | Fri 01 Aug 2 p.m.–2:45 p.m.
Presented by
-
Mike Jang
@na
https://ai-techwriter.com
Mike is a Principal Technical Writer for NGINX (part of F5) He creates clear and engaging documentation for developers and sysadmins. He's created authoritative content in Linux, security, and Identity Management. He's also a Red Hat Certified Engineer (RHCE v5) and an enthusiastic speaker at industry events.
This year, Mike led the release of the NGINX documentation repository as open source, using the BSD license.
He built a docs-as-code documentation practice from scratch at Cobalt.io, where he also developed a voice and tone style guide for user experiences, taught non-writers to create better UI text, and set up a paid open source documentation contribution program. At GitLab, he guided the documentation efforts for the Manage Stage and developer content. At ForgeRock, he gained seven years of experience writing about Identity Management.
Mike's mission is to share my passion for new software and to help users achieve their goals with the rigor of a technical writer.
Mike Jang
@na
https://ai-techwriter.com
Abstract
This is open source done right. Open sourcing existing software is more than just "pushing a button," It involves serious preparation, including:
- Choosing reasons to go open source
- Auditing security
- Scrubbing PII
- Lawyers and the license
- Deciding what to do about commits
- Setting ground rules for contributors
- Sharing with your community
- Follow-up hackathons
When people look at open source software, they first look at documentation. When open source developers find a promising project, they expect to get involved. One part of the process is with open source software.
Attendees will come out of this session with:
- Access to a template repository
- A checklist to follow, which addresses legal, security, and community requirements
- An understanding of the work required to move to open source
- Tips for hackathons, based on real-world experience with open source newbies
Internally, we overcame barriers before we could "push the button." Externally, we helped open source newbies make substantive contributions, well beyond the "typo fix."
Over the past few days, we've experienced the variety of issues that can come from a hackathon, especially with Git newbies. However, we've found that encouraging new Git users increases the quality of contributions based on the diversity of experiences.
This is open source done right. Open sourcing existing software is more than just "pushing a button," It involves serious preparation, including: - Choosing reasons to go open source - Auditing security - Scrubbing PII - Lawyers and the license - Deciding what to do about commits - Setting ground rules for contributors - Sharing with your community - Follow-up hackathons When people look at open source software, they first look at documentation. When open source developers find a promising project, they expect to get involved. One part of the process is with open source software. Attendees will come out of this session with: - Access to a template repository - A checklist to follow, which addresses legal, security, and community requirements - An understanding of the work required to move to open source - Tips for hackathons, based on real-world experience with open source newbies Internally, we overcame barriers before we could "push the button." Externally, we helped open source newbies make substantive contributions, well beyond the "typo fix." Over the past few days, we've experienced the variety of issues that can come from a hackathon, especially with Git newbies. However, we've found that encouraging new Git users increases the quality of contributions based on the diversity of experiences.