From Fedora Project Wiki
< Server
m (First Part of pages ready for review) |
m (minor editing) |
||
| Line 29: | Line 29: | ||
| [https://fedoraproject.org/wiki/Help:Wiki_syntax_and_markup#Tables Landing Page] | | [https://fedoraproject.org/wiki/Help:Wiki_syntax_and_markup#Tables Landing Page] | ||
| pboy | | pboy | ||
| | | N.N. | ||
| "beta" | | "beta" | ||
|- | |- | ||
| Line 39: | Line 39: | ||
| [https://docs.fedoraproject.org/en-US/fedora-server/server-installation-sbc/ Installation on SBC] | | [https://docs.fedoraproject.org/en-US/fedora-server/server-installation-sbc/ Installation on SBC] | ||
| pboy | | pboy | ||
| | | N.N. | ||
| work in progress | | work in progress | ||
|- | |- | ||
| [https://docs.fedoraproject.org/en-US/fedora-server/server-administration/ Server Administration] | | [https://docs.fedoraproject.org/en-US/fedora-server/server-administration/ Server Administration] | ||
| pboy | | pboy | ||
| | | (tncummings) | ||
| "beta" | | "beta" | ||
|- | |- | ||
| Line 54: | Line 54: | ||
| [https://docs.fedoraproject.org/en-US/fedora-server/server-virtualization/ Server Virtualisation ] | | [https://docs.fedoraproject.org/en-US/fedora-server/server-virtualization/ Server Virtualisation ] | ||
| pboy | | pboy | ||
| | | (tncummings) | ||
| "beta" | | "beta" | ||
|- | |- | ||
| [https://docs.fedoraproject.org/en-US/fedora-server/virtualization-install/ Add Virtualisation Support ] | | [https://docs.fedoraproject.org/en-US/fedora-server/virtualization-install/ Add Virtualisation Support ] | ||
| pboy | | pboy | ||
| | | (tncummings) | ||
| "beta" | | "beta" | ||
|- | |- | ||
| [https://docs.fedoraproject.org/en-US/fedora-server/virtualization-vmcloud/ VMs based on Cloud Images ] | | [https://docs.fedoraproject.org/en-US/fedora-server/virtualization-vmcloud/ VMs based on Cloud Images ] | ||
| pboy | | pboy | ||
| | | N.N. | ||
| "beta" | | "beta" | ||
|- | |- | ||
| [https://docs.fedoraproject.org/en-US/fedora-server/server-faq/ FAQ ] | | [https://docs.fedoraproject.org/en-US/fedora-server/server-faq/ FAQ ] | ||
| copperi | | copperi | ||
| | | N.N. | ||
| "beta" | | "beta" | ||
|- | |- | ||
| [https://docs.fedoraproject.org/en-US/fedora-server/communicating/ Communicating and Getting Help ] | | [https://docs.fedoraproject.org/en-US/fedora-server/communicating/ Communicating and Getting Help ] | ||
| copperi | | copperi | ||
| | | N.N. | ||
| "beta" | | "beta" | ||
|} | |} | ||
Revision as of 15:53, 2 June 2021
There is no documentation here.
This page is about planning and organizing work on Fedora Server documentation.
This page is about planning and organizing work on Fedora Server documentation.
 Server Documentation Team
Activists
|
Goals
- Build up a documentation which will be part of the fedora docs landing page (docs.fedoraproject.org)
- Maybe: Additional information to central "System Administrator's Guide" documentation
- Maybe: Additional information to the central "Installation Guide"
Content to start with
| Page | author | Reviewer | Status |
|---|---|---|---|
| Landing Page | pboy | N.N. | "beta" |
| Server Installation | pboy | nirik | ready |
| Installation on SBC | pboy | N.N. | work in progress |
| Server Administration | pboy | (tncummings) | "beta" |
| Server Post installation tasks | pboy | nirik | ready |
| Server Virtualisation | pboy | (tncummings) | "beta" |
| Add Virtualisation Support | pboy | (tncummings) | "beta" |
| VMs based on Cloud Images | pboy | N.N. | "beta" |
| FAQ | copperi | N.N. | "beta" |
| Communicating and Getting Help | copperi | N.N. | "beta" |
The next steps
- Concretization of the planning. We need
- a rough overall plan of the content
- exemplary topics / themes
- to find contributors / authors
- Set up Working Environment
- Staging Area
- Preparation of publishing pipelines
- Define Milestones
- Most important: minimum requirement for going online
Preliminary planning proposal
Recently I came across an informative article: : "What is good documentation for software projects?" It's not brand new, but it's a good summary of what to look for in a documentation project.
Team
We need skill sets from multiple roles
- Authors/Writers with a deep understanding of the software being described, who create texts, of course
- Information Architects who understands how to structure material
- Reviewers with a deep understanding of the software being described, who ensure technical correctness
- Editor/Reader, especially English native speakers, who proofread the wording and spelling
- Administrator who keeps up the build pipelines and correct web formatting and presentation
- Coordinator, who keeps an eye on the overall plan and helps to align all the processes and people
Guidelines
Notes on the structure of the texts. For example, it would be necessary to regulate:
- Specification of author(s), date of creation, last update, Fedora version with which representations were tested.
- Start with a short summary of the subject matter, objective and desired outcome. (paragraph of 2-3 sentences)
- Divide longer sequences into sections with subheadings and short explanations
- Provide each step with a brief explanation/justification, if possible, a general instruction structure and a concrete example.
Overall Conceptualization of Server Documentation Content
As a first Draft we may discuss (See also: A first draft of a proposal for a concept to improve documentation)
- Navigation Items
- Home / Landing Page Fedora Server Documentation
- Post-installation Procedures / Security Hardening
- Fedora Server Example Use Cases
- Tutorials
- Trouble Shooting Guide / Known Issues
- People, policies, and Working Methods
- Details Home / Landing Page
- Details Post Installation
- Details Example Use Cases
- Details Tutorials
- Details People, Policies, ...