Both code and documentation are essential to the success of any project. The two often go hand in hand to provide the features and clarity needed to solve problems.
That’s why the NGINX team is thrilled to announce that we’re open sourcing the F5 NGINX product documentation. You can now visit the NGINX documentation GitHub repository to witness our ongoing commitment to transparency, community collaboration, and open source. NGINX has deep roots in the open source community, and we’re proud to continue this tradition by opening our documentation for contributions.
Why Open Source the NGINX Docs?
F5 and NGINX are committed to open source. We contribute to open source software designed with the user in mind, respecting privacy and security while promoting a culture of innovation, community, and sustainability.
As documentarians, we understand that docs are essential not only to the success of a product, but also to the success of our community of developers, maintainers, and users. Docs are a good “first issue.” They allow our community to contribute without extensive development experience. By making the NGINX documentation fully open source, we invite you – our community – to help us make NGINX easier to understand and use for people of all experience levels, all over the world.
What This Means for You
You can now send us documentation bug reports, feature requests, and enhancements by filing Issues in the NGINX documentation GitHub repository. You can also submit Pull Requests (PRs) and participate in conversations on our Discussions page. With these resources, you can discuss ideas and challenges with the NGINX team and your peers.
Documentation Details
Based on our commitment to open source, we will do most of our documentation work in our new open source repository. In accordance with best industry practices, we’ll continue to develop some documentation on an internal mirror – specifically for features and security issues that we are not yet ready to announce.
In our documentation repository, we provide instructions on how to use our build tools your proposed changes would appear on docs.nginx.com. For more information, refer to our Contributing guidelines.
For licensing, we’re releasing our content under the license known as the BSD 2-Clause “Simplified” License. This is the same license used for nginx.org.
You can also watch our announcement video below.
Share Your Feedback
Open sourcing the NGINX documentation is still a work in progress. We value your opinions! If you have ideas, reach out. If you find a way to improve our documentation, start a Discussion. We’re here to work with you while maintaining transparency in our actions and direction. We plan to explore even more ways to share information and project direction.
In the meantime, check out our new publicly available NGINX documentation repository on GitHub. We’d appreciate it if you gave the project a star, watched it, or even forked it for your use.
See you in GitHub Discussions and in the NGINX community!