GNUsocial/gnusocial.rocks
4
0
Fork 1
Code Issues Pull Requests Releases Activity
9888d51bc5
gnusocial.rocks/v3/milestone-documentation-and-tests-infrastructure.html

95 lines
4.8 KiB
HTML
Raw Normal View History

[V3][Blog] Add initial content
2021-08-16 19:22:59 +01:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" href="/favicon.ico">
<link rel="stylesheet" href="https://unpkg.com/purecss@2.0.5/build/pure-min.css">
<link rel="stylesheet" href="https://unpkg.com/purecss@2.0.5/build/grids-responsive-min.css">
<link rel="stylesheet" href="https://netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css">
<link rel="stylesheet" href="/assets/css/style.css">
<link rel="stylesheet" href="/v3/blog.css">
<title>Milestone: Documentation and Tests Infrastructure - GNU social V3</title>
</head><body>
<header class="header">
<div class="home-menu pure-menu pure-menu-horizontal pure-menu-fixed">
<a class="pure-menu-heading" href="/">GNU social</a>
<ul class="pure-menu-list">
<li class="pure-menu-item pure-menu-selected"><a href="index.html" class="pure-menu-link">Version 3</a></li>
<li class="pure-menu-item"><a href="https://code.gnusocial.rocks/" class="pure-menu-link">Repository</a></li>
<li class="pure-menu-item"><a href="https://coverage.gnusocial.rocks/" class="pure-menu-link">Code Coverage</a></li>
<li class="pure-menu-item"><a href="https://docs.gnusocial.rocks/" class="pure-menu-link">Documentation</a></li>
<li class="pure-menu-item"><a href="https://agile.gnusocial.rocks/" class="pure-menu-link">Wiki</a></li>
<li class="pure-menu-item"><a href="https://kanban.undefinedhackers.net/?controller=BoardViewController&action=readonly&token=d2293e55cabae7cceff9fb496c651328195357d392b9e61a9f229ed6d463" class="pure-menu-link">Roadmap</a></li>
</ul>
</div>
</header>
<div class="content-wrapper">
<div class="content">
<div id="divbodyholder">
<div class="headerholder"><div class="header">
<div id="title">
<h1 class="nomargin"><a class="ablack" href="https://gnusocial.rocks/v3/index.html">GNU social V3</a></h1>
<div id="description">Development blog where we announce our progress.</div>
</div></div></div>
<div id="divbody"><div class="content">
<!-- entry begin -->
<h3><a class="ablack" href="milestone-documentation-and-tests-infrastructure.html">
Milestone: Documentation and Tests Infrastructure
</a></h3>
<!-- bashblog_timestamp: #202108041337.42# -->
<div class="subtitle">August 04, 2021 &mdash;
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>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>
<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>
<p>And two of them are new:</p>
<ul>
<li>The <a href="https://docs.gnusocial.rocks/developer">Developer</a> is both intended to guide third-party plugin developers and to make it easier of contributing to the code.</li>
<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>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
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>
[V3][Blog] Announce the blog itself
2021-08-16 23:08:02 +01:00
[V3][Blog] Add initial content
2021-08-16 19:22:59 +01:00
<!-- text end -->
<!-- entry end -->
</div>
</div></div>
</div>
<footer class="l-box is-center">
This site's source is <a href="https://code.undefinedhackers.net/GNUsocial/gnusocial.rocks">hosted here</a>.
</footer>
</div>
</body></html>
Copy Permalink