2021-08-16 19:22:59 +01:00
<!DOCTYPE html>
< html lang = "en" >
< head >
2021-08-18 18:16:27 +01:00
< meta charset = "utf-8" >
2021-09-11 18:24:40 +01:00
< meta name = "viewport" content = "width=device-width, initial-scale=0.86, maximum-scale=5.0, minimum-scale=0.86" >
2021-08-18 18:16:27 +01:00
< link rel = "shortcut icon" href = "/favicon.ico" >
2021-09-11 18:24:40 +01:00
< link rel = "stylesheet" href = "https://www.gnusocial.rocks//assets/css/reset.css" >
< link rel = "stylesheet" href = "https://www.gnusocial.rocks//assets/css/blog.css" >
2021-09-13 13:15:59 +01:00
< link rel = 'stylesheet' type = 'text/css' href = "https://www.gnusocial.rocks//assets/fonts/opensans/opensans.css" > < title > Milestone: Documentation and Tests Infrastructure - GNU social V3< / title >
2021-08-16 19:22:59 +01:00
< / head > < body >
2021-08-18 18:16:27 +01:00
< header >
2021-08-18 15:04:03 +01:00
< div class = "home-menu menu menu-horizontal menu-fixed" >
2021-08-18 18:16:27 +01:00
< a class = "menu-heading" href = "https://gnusocial.rocks/" >
< img src = "../assets/img/gnu-social-logo-invert.svg" alt = "GNU social" >
< b > gnu< / b > social
< / a >
2021-08-18 15:04:03 +01:00
< / div >
< div class = "sidebar" >
2021-08-18 18:16:27 +01:00
< ul class = "menu-list" >
2021-08-19 15:37:16 +01:00
< li class = "menu-item menu-selected" > < a href = "index.html" class = "menu-link" > Blog Index< / a > < / li >
2021-08-18 18:16:27 +01:00
< li class = "menu-item" > < a href = "https://code.gnusocial.rocks/" class = "menu-link" > Repository< / a > < / li >
< li class = "menu-item" > < a href = "https://coverage.gnusocial.rocks/" class = "menu-link" > Code Coverage< / a > < / li >
< li class = "menu-item" > < a href = "https://docs.gnusocial.rocks/" class = "menu-link" > Documentation< / a > < / li >
< li class = "menu-item" > < a href = "https://agile.gnusocial.rocks/" class = "menu-link" > Wiki< / a > < / li >
< li class = "menu-item" > < a href = "https://kanban.undefinedhackers.net/?controller=BoardViewController&action=readonly&token=d2293e55cabae7cceff9fb496c651328195357d392b9e61a9f229ed6d463" class = "menu-link" > Roadmap< / a > < / li >
< / ul >
2021-08-18 15:04:03 +01:00
< / div >
2021-08-18 18:16:27 +01:00
< / header >
< div class = "content-wrapper" >
2021-08-18 15:04:03 +01:00
< div class = "content" >
2021-08-16 19:22:59 +01:00
< / div > < / div > < / div >
2021-08-18 18:16:27 +01:00
< div id = "template-wrapper" > < div class = "template-unit" >
2021-08-16 19:22:59 +01:00
<!-- 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 —
GNU social development team
< / div >
<!-- text begin -->
2021-08-19 03:15:11 +01:00
< p > < strong > < a href = "https://agile.gnusocial.rocks/doku.php?id=milestones:initial_test_documentation_infrastructure" > >WIKI Milestone entry< / a > < / strong > < / p >
2021-08-16 19:22:59 +01:00
< p > GNU social now has its documentation available in
< a href = "https://docs.gnusocial.rocks/" > https://docs.gnusocial.rocks/< / a > . It features four
2021-08-19 03:15:11 +01:00
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 >
2021-08-16 19:22:59 +01:00
2021-08-19 03:15:11 +01:00
< blockquote >
< p > Only the development book is in an elaborated state, the other books are
2021-08-16 19:22:59 +01:00
holding for more ready code.< / p >
2021-08-19 03:15:11 +01:00
< / blockquote >
2021-08-16 19:22:59 +01:00
2021-08-19 03:15:11 +01:00
< p > And two of them are new:< / p >
2021-08-16 19:22:59 +01:00
< ul >
2021-08-19 03:15:11 +01:00
< 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 >
2021-08-16 19:22:59 +01:00
< / ul >
2021-08-19 03:15:11 +01:00
< p > And two of them are updates from existing documentation:< / p >
2021-08-16 19:22:59 +01:00
< ul >
2021-08-19 03:15:11 +01:00
< 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 >
2021-08-16 19:22:59 +01:00
< / 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,
2021-08-19 03:15:11 +01:00
convention, terminology. It's where we document the reasoning the development team went
2021-08-16 19:22:59 +01:00
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
2021-08-19 03:15:11 +01:00
< 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 >
2021-08-18 15:04:03 +01:00
2021-08-19 03:20:52 +01:00
2021-08-19 03:33:16 +01:00
2021-08-19 15:37:16 +01:00
2021-09-11 18:24:40 +01:00
2021-09-13 13:15:59 +01:00
2021-09-13 17:37:40 +01:00
2021-11-03 01:49:52 +00:00
2021-12-05 22:31:06 +00:00
2021-08-16 19:22:59 +01:00
<!-- text end -->
<!-- entry end -->
< / div >
< / div > < / div >
2021-09-13 13:15:59 +01:00
< footer class = "footer l-box is-center" >
This site's source is
< a href = "https://code.undefinedhackers.net/GNUsocial/gnusocial.rocks" > hosted here< / a > .
< / footer > < / body > < / html >
