Hello all, As I finish up the preparations for the Server Guide to transition to diataxis, I was wondering if I could get your feedback on a few items.
The first is the new home page. I created a page for its proposal here <https://discourse.ubuntu.com/t/proposed-ubuntu-server-guide-homepage-using-diataxis/30895> (excluding the full navigation section), and can move its contents over to the current home page <https://ubuntu.com/server/docs> next, which will automatically update the guide's navigation. It's meant to match the standard homepage documentation <https://docs.google.com/document/d/1Zw-UoQzHMSQjATLXjjvd9GKu5qU2mHmqxtKck8nGkbU> as closely as possible, similar to Ubuntu Core <https://ubuntu.com/core/docs>. If there is anything that can be worded better, or that is missing and should be there let me know! Second are the diataxis home pages: Tutorials <https://discourse.ubuntu.com/t/ubuntu-server-tutorials/29948>, How-to guides <https://discourse.ubuntu.com/t/ubuntu-server-how-to-guides/29950>, Explanations <https://discourse.ubuntu.com/t/ubuntu-server-explanation-guides/29951> and Reference <https://discourse.ubuntu.com/t/ubuntu-server-reference/29949>. These are meant to be similar to Ubuntu Core's sections: Tutorials <https://ubuntu.com/core/docs/tutorials>, How-to <https://ubuntu.com/core/docs/how-to>, Explanation <https://ubuntu.com/core/docs/explanation>, and Reference <https://ubuntu.com/core/docs/reference>. Lastly I would like your opinion on formatting for some of the existing server guide pages. Many of our pages focus on individual packages, and while doing so contain portions that vary in terms of what part of diataxis they fall under. For example, in the Squid page <https://ubuntu.com/server/docs/proxy-servers-squid>, the first two paragraphs are an explanation, followed by the Installation and Configuration sections which are technically tutorials, and ending with the References section which of course falls under reference. There are two main options I could move forward with here. The first would be to split the page up to purely match diataxis, possibly adding some more depth to the explanation, while creating a new page specifically as a tutorial for installing/configuring the package. The second would be to leave the page as it currently is and mark it as a reference. This would likely be easier for users to follow since they would be able to reference all important information about a given package without going to multiple pages. This change would affect most single-page packages in the Services and Tools section of the guide. Larger guides, however, such as OpenLDAP <https://ubuntu.com/server/docs/service-ldap-introduction>, can be split much more cleanly by page between the four categories. Thanks, Lena
-- ubuntu-server mailing list ubuntu-server@lists.ubuntu.com https://lists.ubuntu.com/mailman/listinfo/ubuntu-server More info: https://wiki.ubuntu.com/ServerTeam
