Skip to content

Commit

Permalink
guidelines/editing: Add process guidelines for creating and reviewing…
Browse files Browse the repository at this point in the history
… a new article.
  • Loading branch information
r12a committed Dec 13, 2023
1 parent c5e86ca commit 5b1787e
Showing 1 changed file with 51 additions and 1 deletion.
52 changes: 51 additions & 1 deletion guidelines/editing.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,10 @@ <h2>General principles for editing HTML</h2>
</section>






<section id="othermarkup">
<h2>General markup guidelines</h2>

Expand Down Expand Up @@ -391,6 +395,10 @@ <h3>Change markup</h3>







<section id="inline">
<h2>Marking up inline content</h2>

Expand Down Expand Up @@ -563,7 +571,6 @@ <h3>Other inline markup</h3>
usages can be styled differently (esp. for documents with
translations!).</p>
</section>
</section>



Expand Down Expand Up @@ -669,6 +676,49 @@ <h2>Suggested styling for local.css</h2>
</code></pre>
</section>





<section id="process">
<h2>Creating a new article</h2>

<p>To create a new article take an existing page's code as a template and modify it as needed.</p>




<section id="reviews">
<h3>Getting reviews</h3>

<p>The process we normally follow is:</p>

<ol>
<li>Once you have a basic start on the text, publish the article to GitHub and add an item to the weekly meeting agenda and ask people to give thoughts on the direction you are heading in. Tell them not to comment on typos or finer editorial points at this stage: the key is to check that the overall thrust of the content and headings are going in the right direction.
</li>

<li>Once you have a fair copy of the article, building in the feedback from step one, raise another agenda item for the weekly meeting to ask for detailed comments and to propose that the article be sent out for wide review. The WG may ask for substantive changes, in which case you'll need to address the feedback and resubmit for internal review. Alternatively, the group may raise a few smaller points and agree to move the article to wide review once those edits have been made.</li>

<li>Submit the article for wide review by asking for feedback by a given date of the i18n blog (home page news), and in our social media feeds. Copy the pattern of existing announcements, where possible. You should ask for feedback on the version uploaded to GitHub. We haven't often done it in the past, but it might be good to also sent notifications to other groups who are directly concerned with the topic of the article.</li>

<li>Once the specified date has passed, make any necessary changes, check for and fix any validation errors, and go back to the WG telecon to check whether anyone objects to final publication. (In rare cases, you may need to cycle back through the process if substantial edits were made.)</li>

<li>Publish the final article to GitHub and also to CVS.</li>

<li>Add the article to the articlelist-data/translations.js file and upload to CVS. (This file is not uploaded to GitHub.)</li>

<li>Announce the new article via the i18n home page and social media channels.</li>
</ol>
</section>

</section>






</section>
</div>

<br style="clear: both;" />
Expand Down

0 comments on commit 5b1787e

Please sign in to comment.