-
Notifications
You must be signed in to change notification settings - Fork 282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
write an article to describe the process of creating a new article #1820
Comments
@serge This is an interesting concept. I think that what we could do (and @wsoyinka could attest to this) a branch called " docreview" or something along those lines, that everyone would have read access and we (those editors, administrators with the current write access to the documentation repository) would have merge access in this new branch too. The difference is that no document would be refused at this stage. We would merge it into docreview and there it would receive the scrutiny you are talking about before it would be approved and a PR generated from this to documentation. The downside of doing this, is that it could be a deterrent to contribution, and god knows we don't need any other deterrents to documentation. Taking into account and writing additions to the style guide, so that they include logical paths (directories w/o spaces in them and lower case) as well as logical file naming (no capitals, lower-case, only underscores and dashes accepted as characters in the names, etc) would be written in. I think we do this even if we end up not doing the overall proposal here. IF we use your proposal, I think we need to set a time-limit to the review and make sure that documents are quickly reviewed and approved or rejected so that contributors don't end up having their contributions languish in a no-mans land that we aren't paying enough attention to. |
@sspencerwire , @Grammaresque , @gannazhyrnova , @wsoyinka , @alemorvan , ...
https://chat.rockylinux.org/rocky-linux/channels/documentation |
Need to write a (style) guide to describe the process for creating new articles (how_to_write_a_new_rockydocs_item).
This guide (itself) is an example for the ideas to develop and discuss in this issue.
Ideas:
Steps
Proposal for the path (first location) of the new article (new)
documentation/docs/new/.../.../.../new-guides/neuer_artikel_prozess_beschreibung.md
documentation/docs/new/.../.../.../new-guides/processus_de_creation_de_nouvel_article.md
documentation/docs/new/.../.../.../new-guides/how_to_write_a_new_rockydocs_item.md
Proposal for the path (final location) of the basis article (ready to translate)
documentation/docs/guides/.../how_to....md
The text was updated successfully, but these errors were encountered: