improve text of post 2

This commit is contained in:
Diogo Peralta Cordeiro 2021-08-19 03:15:11 +01:00
parent 94b8112060
commit 69d0d5d6e0
Signed by: diogo
GPG Key ID: 18D2D35001FBFAB0
8 changed files with 57 additions and 173 deletions

View File

@ -2,8 +2,8 @@
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/">
<channel><title>GNU social V3</title><link>https://gnusocial.rocks/v3/index.html</link>
<description>Development blog where we announce our progress.</description><language>en</language>
<lastBuildDate>Thu, 19 Aug 2021 03:09:11 +0100</lastBuildDate>
<pubDate>Thu, 19 Aug 2021 03:09:11 +0100</pubDate>
<lastBuildDate>Thu, 19 Aug 2021 03:15:08 +0100</lastBuildDate>
<pubDate>Thu, 19 Aug 2021 03:15:08 +0100</pubDate>
<atom:link href="https://gnusocial.rocks/v3/feed.rss" rel="self" type="application/rss+xml" />
<item><title>
Updates: V3 blog
@ -25,6 +25,7 @@ forget to subscribe!</p>
<!-- text end -->
]]></description><link>https://gnusocial.rocks/v3/updates-v3-blog.html</link>
<guid>https://gnusocial.rocks/v3/./updates-v3-blog.html</guid>
@ -115,6 +116,7 @@ functionality with more stability.</p>
<!-- text end -->
@ -216,6 +218,7 @@ any remote URL being shared in a note.</li>
<!-- text end -->
@ -297,6 +300,7 @@ Updates: Finish the Avatar component
<!-- text end -->
@ -308,23 +312,16 @@ Updates: Finish the Avatar component
Milestone: Documentation and Tests Infrastructure
</title><description><![CDATA[
<p><strong><a href="https://agile.gnusocial.rocks/doku.php?id=milestones:initial_test_documentation_infrastructure">WIKI Milestone entry</a></strong></p>
<p><strong><a href="https://agile.gnusocial.rocks/doku.php?id=milestones:initial_test_documentation_infrastructure">>WIKI Milestone entry</a></strong></p>
<p>GNU social now has its documentation available in
<a href="https://docs.gnusocial.rocks/">https://docs.gnusocial.rocks/</a>. It features four
different books. It is automatically generated from the <a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/docs">source</a> using <a href="https://rust-lang.github.io/mdBook/">mdBook</a>.</p>
different books. These are automatically generated from the <a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/docs">source</a> using <a href="https://rust-lang.github.io/mdBook/">mdBook</a>.</p>
<p>Only the development book is in an elaborated state, the other books are
<blockquote>
<p>Only the development book is in an elaborated state, the other books are
holding for more ready code.</p>
<p>Two of them are updates from existing documentation:</p>
<ul>
<li>The <a href="https://docs.gnusocial.rocks/user">User</a> one is adapted
from the existing GNU social documentation for users that was provided in v2.</li>
<li>The <a href="https://docs.gnusocial.rocks/administrator">Administrator</a> one is adapted
from the "Unofficial GNU social docs" by Thomask who <a href="https://notabug.org/diogo/gnu-social/issues/246">asked us to make it official</a>.</li>
</ul>
</blockquote>
<p>And two of them are new:</p>
@ -333,79 +330,23 @@ from the "Unofficial GNU social docs" by Thomask who <a href="https://notabug.or
<li>The <a href="https://docs.gnusocial.rocks/designer">Designer</a> is the most recent of the four and came from a necessity of keeping some standardization between templates and ensuring the same principles are kept in mind when designing new themes.</li>
</ul>
<p>And two of them are updates from existing documentation:</p>
<ul>
<li>The <a href="https://docs.gnusocial.rocks/user">User</a> one is adapted
from the existing GNU social documentation for users that was provided in v2.</li>
<li>The <a href="https://docs.gnusocial.rocks/administrator">Administrator</a> one is adapted
from the "Unofficial GNU social docs" by Thomask who <a href="https://notabug.org/diogo/gnu-social/issues/246">asked us to make it official</a>.</li>
</ul>
<p>Together with the documentation we've introduced a
<a href="https://agile.gnusocial.rocks/">wiki</a>. Its purpose is to walk-through decisions,
convention, terminology. It's where we document the reasoning the dev team went
convention, terminology. It's where we document the reasoning the development team went
through before implementing more sophisticated functionalities.</p>
<p>Finally, when the documentation doesn't explain, and to ensure the whole code
is properly tested, we have the
<a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/tests">tests</a>. And the coverage is available <a href="https://coverage.gnusocial.rocks/">here</a>.</p>
<a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/tests">tests</a>. And the coverage is available <a href="https://coverage.gnusocial.rocks/">here</a>. At the time of writing the coverage has 98.76% code lines tested.</p>
<!-- text end -->
@ -457,6 +398,7 @@ The key ones are:</p>
<a href="https://docs.gnusocial.rocks/developer/storage.html">documentation</a>.</p>
<!-- text end -->
]]></description><link>https://gnusocial.rocks/v3/milestone-port-media-handling-from-v2.html</link>
<guid>https://gnusocial.rocks/v3/./milestone-port-media-handling-from-v2.html</guid>

View File

@ -43,23 +43,16 @@ GNU social development team
</div>
<!-- text begin -->
<p><strong><a href="https://agile.gnusocial.rocks/doku.php?id=milestones:initial_test_documentation_infrastructure">WIKI Milestone entry</a></strong></p>
<p><strong><a href="https://agile.gnusocial.rocks/doku.php?id=milestones:initial_test_documentation_infrastructure">>WIKI Milestone entry</a></strong></p>
<p>GNU social now has its documentation available in
<a href="https://docs.gnusocial.rocks/">https://docs.gnusocial.rocks/</a>. It features four
different books. It is automatically generated from the <a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/docs">source</a> using <a href="https://rust-lang.github.io/mdBook/">mdBook</a>.</p>
different books. These are automatically generated from the <a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/docs">source</a> using <a href="https://rust-lang.github.io/mdBook/">mdBook</a>.</p>
<p>Only the development book is in an elaborated state, the other books are
<blockquote>
<p>Only the development book is in an elaborated state, the other books are
holding for more ready code.</p>
<p>Two of them are updates from existing documentation:</p>
<ul>
<li>The <a href="https://docs.gnusocial.rocks/user">User</a> one is adapted
from the existing GNU social documentation for users that was provided in v2.</li>
<li>The <a href="https://docs.gnusocial.rocks/administrator">Administrator</a> one is adapted
from the "Unofficial GNU social docs" by Thomask who <a href="https://notabug.org/diogo/gnu-social/issues/246">asked us to make it official</a>.</li>
</ul>
</blockquote>
<p>And two of them are new:</p>
@ -68,79 +61,23 @@ from the "Unofficial GNU social docs" by Thomask who <a href="https://notabug.or
<li>The <a href="https://docs.gnusocial.rocks/designer">Designer</a> is the most recent of the four and came from a necessity of keeping some standardization between templates and ensuring the same principles are kept in mind when designing new themes.</li>
</ul>
<p>And two of them are updates from existing documentation:</p>
<ul>
<li>The <a href="https://docs.gnusocial.rocks/user">User</a> one is adapted
from the existing GNU social documentation for users that was provided in v2.</li>
<li>The <a href="https://docs.gnusocial.rocks/administrator">Administrator</a> one is adapted
from the "Unofficial GNU social docs" by Thomask who <a href="https://notabug.org/diogo/gnu-social/issues/246">asked us to make it official</a>.</li>
</ul>
<p>Together with the documentation we've introduced a
<a href="https://agile.gnusocial.rocks/">wiki</a>. Its purpose is to walk-through decisions,
convention, terminology. It's where we document the reasoning the dev team went
convention, terminology. It's where we document the reasoning the development team went
through before implementing more sophisticated functionalities.</p>
<p>Finally, when the documentation doesn't explain, and to ensure the whole code
is properly tested, we have the
<a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/tests">tests</a>. And the coverage is available <a href="https://coverage.gnusocial.rocks/">here</a>.</p>
<a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/tests">tests</a>. And the coverage is available <a href="https://coverage.gnusocial.rocks/">here</a>. At the time of writing the coverage has 98.76% code lines tested.</p>
<!-- text end -->

View File

@ -1,31 +1,31 @@
Milestone: Documentation and Tests Infrastructure
**[WIKI Milestone entry](https://agile.gnusocial.rocks/doku.php?id=milestones:initial_test_documentation_infrastructure)**
**[>WIKI Milestone entry](https://agile.gnusocial.rocks/doku.php?id=milestones:initial_test_documentation_infrastructure)**
GNU social now has its documentation available in
[https://docs.gnusocial.rocks/](https://docs.gnusocial.rocks/). It features four
different books. It is automatically generated from the [source](https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/docs) using [mdBook](https://rust-lang.github.io/mdBook/).
different books. These are automatically generated from the [source](https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/docs) using [mdBook](https://rust-lang.github.io/mdBook/).
Only the development book is in an elaborated state, the other books are
holding for more ready code.
Two of them are updates from existing documentation:
* The [User](https://docs.gnusocial.rocks/user) one is adapted
from the existing GNU social documentation for users that was provided in v2.
* The [Administrator](https://docs.gnusocial.rocks/administrator) one is adapted
from the "Unofficial GNU social docs" by Thomask who [asked us to make it official](https://notabug.org/diogo/gnu-social/issues/246).
> Only the development book is in an elaborated state, the other books are
> holding for more ready code.
And two of them are new:
* The [Developer](https://docs.gnusocial.rocks/developer) is both intended to guide third-party plugin developers and to make it easier of contributing to the code.
* The [Designer](https://docs.gnusocial.rocks/designer) is the most recent of the four and came from a necessity of keeping some standardization between templates and ensuring the same principles are kept in mind when designing new themes.
And two of them are updates from existing documentation:
* The [User](https://docs.gnusocial.rocks/user) one is adapted
from the existing GNU social documentation for users that was provided in v2.
* The [Administrator](https://docs.gnusocial.rocks/administrator) one is adapted
from the "Unofficial GNU social docs" by Thomask who [asked us to make it official](https://notabug.org/diogo/gnu-social/issues/246).
Together with the documentation we've introduced a
[wiki](https://agile.gnusocial.rocks/). Its purpose is to walk-through decisions,
convention, terminology. It's where we document the reasoning the dev team went
convention, terminology. It's where we document the reasoning the development team went
through before implementing more sophisticated functionalities.
Finally, when the documentation doesn't explain, and to ensure the whole code
is properly tested, we have the
[tests](https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/tests). And the coverage is available [here](https://coverage.gnusocial.rocks/).
[tests](https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/tests). And the coverage is available [here](https://coverage.gnusocial.rocks/). At the time of writing the coverage has 98.76% code lines tested.

View File

@ -83,6 +83,7 @@ The key ones are:</p>
<a href="https://docs.gnusocial.rocks/developer/storage.html">documentation</a>.</p>
<!-- text end -->
<!-- entry end -->
</div>

View File

@ -113,6 +113,7 @@ GNU social development team
<!-- text end -->

View File

@ -124,6 +124,7 @@ functionality with more stability.</p>
<!-- text end -->

View File

@ -133,6 +133,7 @@ any remote URL being shared in a note.</li>
<!-- text end -->

View File

@ -59,6 +59,7 @@ forget to subscribe!</p>
<!-- text end -->
<!-- entry end -->
</div>