Infrastructure/infra-docs-fpo
3
0
Fork 0
Code Issues 100 Pull requests 6 Projects Releases Packages Wiki Activity Actions

Sysadmin Guide move to Fedora Docs #4

New issue
Closed
opened 2020-09-04 15:39:17 +00:00 by pbokoc · 3 comments
pbokoc commented 2020-09-04 15:39:17 +00:00
Copy link

The Infra Sysadmin Guide is currently published on ReadTheDocs, here: https://fedora-infra-docs.readthedocs.io/en/latest/sysadmin-guide/index.html. The repository is here: https://pagure.io/infra-docs

The aim of this ticket is to move the guide to Fedora Docs, into this repository. This means switching the markup from RST to ASCIIDoc, moving content into the sysadmin_guide module which already exists in this repository, and replacing the current table of contents (nav.adoc) inside the module with a proper one, instead of the current external link.

This is a big task, and you are not expected to convert the whole guide alone. Instead, check the sysadmin_guide feature branch and check what is missing. Then, pick an unconverted chapter from the original sources, add it, and open a PR against this branch. Once all the chapters are converted, we will merge the feature branch to master and close this issue.

The Infra Sysadmin Guide is currently published on ReadTheDocs, here: https://fedora-infra-docs.readthedocs.io/en/latest/sysadmin-guide/index.html. The repository is here: https://pagure.io/infra-docs The aim of this ticket is to move the guide to Fedora Docs, into this repository. This means switching the markup from RST to ASCIIDoc, moving content into the `sysadmin_guide` module which already exists in this repository, and replacing the current table of contents (`nav.adoc`) inside the module with a proper one, instead of the current external link. **This is a big task, and you are not expected to convert the whole guide alone.** Instead, check the `sysadmin_guide` feature branch and check what is missing. Then, pick an unconverted chapter from the original sources, add it, and open a PR against this branch. Once all the chapters are converted, we will merge the feature branch to `master` and close this issue.
zlopez commented 2021-11-16 09:42:33 +00:00
Contributor
Copy link

The Getting Started link on the sysadmin main page is still pointing to old documentation.

The Getting Started link on the [sysadmin main page](https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/) is still pointing to old documentation.
zlopez commented 2022-04-21 13:19:08 +00:00
Contributor
Copy link

Links are now fixed and the guide is fully moved.

Links are now fixed and the guide is fully moved.
zlopez commented 2022-04-21 13:19:09 +00:00
Contributor
Copy link

Metadata Update from @zlopez:

  • Issue status updated to: Closed (was: Open)
**Metadata Update from @zlopez**: - Issue status updated to: Closed (was: Open)
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
No results found.
Labels
Clear labels   
rerwite-required

   
SOP

   
untriaged
  
blocked

Indicates the work cannot proceed. There is a dependency or an issue that is preventing the team from completing the task. This is a flag for the Scrum Master to help unblock the team.

  
Bug

The software is not behaving as expected. It could be an error, a crash, or an incorrect result. Bugs often need to be prioritized based on their severity and business impact

  
Chore

Tasks that are necessary but don't directly deliver new value to the end-user. These are internal tasks like updating a library, managing user accounts, or setting up a new service.

  
Feature

It's something that a user would be able to see or interact with, such as a new button, a new page, or an improved workflow.

  
in-progress

This label is for work that a developer is actively working on. This is usually what you'll see on the "In Progress" column of your project board.

  
points:1

A task that is simple, small, and has very little uncertainty. It should be easy enough for any team member to pick up and complete quickly, without a lot of discussion or research.

  
points:13

Any task that feels like it's a "13" or more is considered an Epic. These are too large and uncertain to be worked on in a single sprint.

  
points:2

This is a task that is slightly more complex or larger than a "1." It might involve two or three simple steps, but the outcome is still very clear and there's little uncertainty.

  
points:3

medium-sized task with some noticeable complexity. It might require a bit more thought or collaboration. The steps are well-defined, but it's not a trivial change.

  
points:5

a significant piece of work. It has more complexity and a higher degree of uncertainty than smaller tasks. It might require some research, a design discussion, or collaboration across multiple teams.

  
points:8

complex task with a lot of uncertainty. It's often the largest size that a team will consider for a single sprint. It likely requires a detailed breakdown and multiple team members to complete.

  
priority:high

This is for work that is critical and needs to be addressed in the next sprint. It's often for urgent bugs, important features, or a major piece of technical debt that is blocking other work.

  
priority:low

This is for work that is good to do but not urgent. It's a candidate for being worked on when there's extra time or when it rises in importance. It can stay in the backlog for a longer period.

  
priority:medium

This is for important work that should be done soon, but isn't as urgent as a high-priority item. It will likely be considered for the next 1-2 sprints.

  
ready

indicates that an issue has been fully refined, has a story point value, and is ready to be pulled into a sprint. It has all the information needed for a developer to start working on it immediately.

  
review

This indicates that the work is complete, but it is now in a review state. This could mean a peer code review, a QA check, or a review by the Product Owner.

  
Technical Debt

work that improves the codebase without adding new features. It's work that pays down the "debt" you've accumulated, such as refactoring a messy piece of code, improving test coverage.

No labels
rerwite-required
SOP
untriaged
blocked
Bug
Chore
Feature
in-progress
points:1
points:13
points:2
points:3
points:5
points:8
priority:high
priority:low
priority:medium
ready
review
Technical Debt
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Infrastructure/infra-docs-fpo#4
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?