Documentation Working Group: Difference between revisions

From OpenSFS Wiki
Jump to navigation Jump to search
← Older edit
Spitzcor (talk | contribs)
69 edits
m Fix formatting
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Ellis Wilson is starting a DWG and made an announcement to [email protected] (http://lists.lustre.org/pipermail/lustre-discuss-lustre.org/2024-August/019237.html):
[[Category:DWG]]
<nowiki>
Hi all,


After some discussions with Peter I've agreed to lead the startup of the Lustre Documentation Working Group (DWG).  The idea here is to have a regular session in-place where we can identify especially missing or stale documentation that would benefit the community were it updated or completed.  Everyone interested in participating would get together every two weeks and we'd review what we made progress on since the last meeting, decide what we're working on until the next one, and discuss any notable areas in need of new or revised documentation soonest.
The [http://www.opensfs.org OpenSFS] Lustre Documentation Working Group (DWG) is the place the where the participants of OpenSFS participate in Lustre documentation creation and improvement.


The three broad capacities we are looking for folks to contribute include the following:
== Goals ==
1. Reviewing documentation and annotating errant, stale, or missing information
2. Editing documentation based on review comments and driving changes to acceptance
3. Creation of new documentation for undocumented or new Lustre features and functionality


The two areas we plan to focus efforts to start are on the Lustre Wiki and the Lustre Manual.
A non-exhaustive list of goals for this community include:


If you have any interest in participating in this working group, please do two things:
* Review of extant Lustre documentation for errors, staleness, and missing content
* Creation of presently non-existent Lustre documentation
* Revision of Lustre documentation that includes stale information or errors
* Prioritization of Lustre documentation efforts
* Streamlining Lustre uptake with beginner administrator and developer information


1. Please fill out this form so I have an idea of what video conferencing software people prefer, what times on Monday's (my only truly open-ish day) work for you, and how you plan to participate: https://forms.office.com/r/swDiczSayq
== Email List ==
2. Go sign up for the DWG email distribution list.  All future email on this topic will be sent there: http://lists.opensfs.org/listinfo.cgi/dwg-opensfs.org


I will send a meeting invitation based on the platform chosen this Friday for the following Monday. Looking forward to kicking this off with you all!
Please join the [http://lists.opensfs.org/listinfo.cgi/dwg-opensfs.org DWG Email List] to stay up-to-date on the progress and on-goings of the DWG.


Best,
== Leadership ==


ellis</nowiki>
Ellis Wilson presently organizes this working group.
 
== Meetings ==
 
Occur every other Monday at 11:30AM Eastern time.  At present the meeting is held in Teams per a vote held upon working group formation.  [https://teams.microsoft.com/l/meetup-join/19%3ameeting_MTdhZWNmOGMtYmVkMS00ZmNiLWI5ZGItMjc1Y2FkODczNjg4%40thread.v2/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-41af-91ab-2d7cd011db47%22%2c%22Oid%22%3a%226791a4c2-3de4-4c6c-957b-11cdc2133f63%22%7d Click here for a direct link to the teams meeting].  Alternatively, contact Ellis via the working group list.
 
== Meeting Minutes ==
 
Minutes are kept for DWG meetings on the [https://wiki.lustre.org lustre.org wiki], and can be located by simply searching for "DWG Minutes" or clicking on the DWG category tag.  They are no longer listed here to reduce the manual update burden.
 
== References ==
[https://jira.whamcloud.com/projects/LUDOC/issues/LUDOC-463?filter=allopenissues LUDOC Open Issues]

Latest revision as of 17:33, 29 September 2025


The OpenSFS Lustre Documentation Working Group (DWG) is the place the where the participants of OpenSFS participate in Lustre documentation creation and improvement.

Goals

A non-exhaustive list of goals for this community include:

  • Review of extant Lustre documentation for errors, staleness, and missing content
  • Creation of presently non-existent Lustre documentation
  • Revision of Lustre documentation that includes stale information or errors
  • Prioritization of Lustre documentation efforts
  • Streamlining Lustre uptake with beginner administrator and developer information

Email List

Please join the DWG Email List to stay up-to-date on the progress and on-goings of the DWG.

Leadership

Ellis Wilson presently organizes this working group.

Meetings

Occur every other Monday at 11:30AM Eastern time. At present the meeting is held in Teams per a vote held upon working group formation. Click here for a direct link to the teams meeting. Alternatively, contact Ellis via the working group list.

Meeting Minutes

Minutes are kept for DWG meetings on the lustre.org wiki, and can be located by simply searching for "DWG Minutes" or clicking on the DWG category tag. They are no longer listed here to reduce the manual update burden.

References

LUDOC Open Issues

Retrieved from "http://wiki.opensfs.org/index.php?title=Documentation_Working_Group&oldid=2698"