This page's purpose is to call JBoss Community mentors for participation. Technical writers, please see GSOC:JBoss @Google Season of Docs welcoming technical writers page. |
Google Season of Docs provides support for open source projects to improve their documentation and gives professional technical writers an opportunity to gain experience in open source. Together we raise awareness of open source, of docs, and of technical writing. The goal of the program is to empower open source organizations to understand their documentation needs, to create documentation to fill those needs, to measure the effect and impact of their documentation, and, in the spirit of open source, share what they've learned to help guide other projects. Season of Docs seeks to bring more technical writers into open source through funding their work with open source projects and organizations.
Technical writers are welcome to participate in the Google Season of Docs 2021 program with the JBoss Community!
Note that the list of accepted organizations in the Google Season of Docs 2021 program will be announced on April 16, 2021 at 18:00 UTC by Google.
For mentors interested to participate in GSoC 2021 please create your project idea below based on the template.
You may find some example project ideas in GSoD page here: https://developers.google.com/season-of-docs/docs/project-ideas
For now, if you have any questions, please contact the GSoD administrators:
Ali Ok (aliok AT redhat DOT com) and George Zaronikas (gzaronikas).
Summary of idea:
-Idea
-Feature A
-Feature B
Knowledge prerequisite: Languages/Technologies goes here
Github repo:
Skill level: Beginner/Intermediate/Advanced
Contact(s) / potential mentors(s): Mentor(s) name and contact details
Associated JBoss community project(s):
Project title: Review and Revamp the Glossary Page on WildFly Docs
Summary of idea:
Many new beginners while starting their journey with JBOSS, want to become more familiar with the common terms used in the WildFly world.
The glossary page should have a list of such terms/words which will help a new contributor have more familiarity with the technical terms.
The glossary will also point to few quick start guides which will complete the loop and have the contributors use WildFly right away.
-Idea
1. Build a strong and meaningful glossary page
2. Integrate some with the quickstart guides repo
Knowledge prerequisite: JAVA, GIT, Shell, Maven, asciidoc
Github repo: https://github.com/wildfly/wildfly/tree/master/docs
Skill level: Beginner/Intermediate
Contact(s) / potential mentors(s): Sudeshna Sur (sudeshna@redhat.com)
Associated JBoss community project(s): WildFly
Infinispan is an in-memory, distributed data store. It’s a fast-paced open source project teamed with energetic, yet laid-back, developers and community contributors. It’s a small team but we get lots done while trying to inspire the best in ourselves and each other.
As a technology offering, Infinispan is used as an application caching layer for high performance and fault-tolerant access to data. Infinispan is also sponsored by Red Hat and used in several large organizations to ensure business continuity. Because Infinispan is quite elastic by nature, it scales easily and is suited for cloud-native applications and efficient resource usage.
Infinispan’s documentation set has recently expanded to include user stories for our Kubernetes Operator while also adopting a more task-oriented, topic-based approach to content development. We’re looking for technical writers who are tech-savvy and like to roll up their sleeves and dig into projects. This is a good opportunity for a junior writer to gain experience with an open-source project and build a portfolio. Writers with more experience might find opportunities for learning modern technology usage patterns, improving continuous delivery pipelines for documentation, and contributing to overall content strategy.
Before you begin:
What you will lean:
What you will do: