Hi all,
In an effort to try to spread knowledge on how to do things in the Fedora Infrastructure, let's try to use a How To git repo [0].
The goal is to add there files with the description on How to complete a certain task. For example I have added a file for How to delete a virtual instance [1]. If we try to use this repo when we process tickets, I think it has the potential to become a good knowledge base that would be useful for all of us.
Why not add that information in the SOP ?
The SOP[2] are usually dedicated to one system or one application, in order to complete a task you might have to execute steps on different services and/or applications. Also it is, I believe easier to search for something like "How to create a new mailing list" rather than having to know that we are using mailman for mailing list and then search for the mailing list SOP.
Let me know what you think about trying this ?
[0] - https://pagure.io/Fedora-Infra/howtos [1] - https://pagure.io/Fedora-Infra/howtos/blob/master/f/destroy_a_virt_instance.... [2] - https://fedora-infra-docs.readthedocs.io/en/latest/sysadmin-guide/index.html
From my apprentice point of view, it's seems a very good idea! Useful for newcomers to start learning about infra tasks.
Il mar 11 feb 2020, 17:01 Clement Verna cverna@fedoraproject.org ha scritto:
Hi all,
In an effort to try to spread knowledge on how to do things in the Fedora Infrastructure, let's try to use a How To git repo [0].
The goal is to add there files with the description on How to complete a certain task. For example I have added a file for How to delete a virtual instance [1]. If we try to use this repo when we process tickets, I think it has the potential to become a good knowledge base that would be useful for all of us.
Why not add that information in the SOP ?
The SOP[2] are usually dedicated to one system or one application, in order to complete a task you might have to execute steps on different services and/or applications. Also it is, I believe easier to search for something like "How to create a new mailing list" rather than having to know that we are using mailman for mailing list and then search for the mailing list SOP.
Let me know what you think about trying this ?
[0] - https://pagure.io/Fedora-Infra/howtos [1] - https://pagure.io/Fedora-Infra/howtos/blob/master/f/destroy_a_virt_instance.... [2] - https://fedora-infra-docs.readthedocs.io/en/latest/sysadmin-guide/index.html _______________________________________________ infrastructure mailing list -- infrastructure@lists.fedoraproject.org To unsubscribe send an email to infrastructure-leave@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/infrastructure@lists.fedorapro...
Good idea, we just need to think about a way to make this more visible as a main source of knowledge.
Michal
On 11/02/2020 17:00, Clement Verna wrote:
Hi all,
In an effort to try to spread knowledge on how to do things in the Fedora Infrastructure, let's try to use a How To git repo [0].
The goal is to add there files with the description on How to complete a certain task. For example I have added a file for How to delete a virtual instance [1]. If we try to use this repo when we process tickets, I think it has the potential to become a good knowledge base that would be useful for all of us.
Why not add that information in the SOP ?
The SOP[2] are usually dedicated to one system or one application, in order to complete a task you might have to execute steps on different services and/or applications. Also it is, I believe easier to search for something like "How to create a new mailing list" rather than having to know that we are using mailman for mailing list and then search for the mailing list SOP.
Let me know what you think about trying this ?
[0] - https://pagure.io/Fedora-Infra/howtos [1] - https://pagure.io/Fedora-Infra/howtos/blob/master/f/destroy_a_virt_instance.... [2] - https://fedora-infra-docs.readthedocs.io/en/latest/sysadmin-guide/index.html
infrastructure mailing list -- infrastructure@lists.fedoraproject.org To unsubscribe send an email to infrastructure-leave@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/infrastructure@lists.fedorapro...
On Tue, Feb 11, 2020 at 4:01 PM Clement Verna cverna@fedoraproject.org wrote:
Hi all,
In an effort to try to spread knowledge on how to do things in the Fedora Infrastructure, let's try to use a How To git repo [0].
+1000
The goal is to add there files with the description on How to complete a certain task. For example I have added a file for How to delete a virtual instance [1]. If we try to use this repo when we process tickets, I think it has the potential to become a good knowledge base that would be useful for all of us.
Why not add that information in the SOP ?
Absolutely and to add another angle, it would be super if someone recorded a solution where it made sense (i.e. privacy centric!). I personally search for readme files and a quick video in case the instructions are unclear or in case my own doubt creeps in!!
The SOP[2] are usually dedicated to one system or one application, in order to complete a task you might have to execute steps on different services and/or applications. Also it is, I believe easier to search for something like "How to create a new mailing list" rather than having to know that we are using mailman for mailing list and then search for the mailing list SOP.
Let me know what you think about trying this ?
[0] - https://pagure.io/Fedora-Infra/howtos [1] - https://pagure.io/Fedora-Infra/howtos/blob/master/f/destroy_a_virt_instance.... [2] - https://fedora-infra-docs.readthedocs.io/en/latest/sysadmin-guide/index.html _______________________________________________ infrastructure mailing list -- infrastructure@lists.fedoraproject.org To unsubscribe send an email to infrastructure-leave@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/infrastructure@lists.fedorapro...
On Tue, Feb 11, 2020 at 05:00:44PM +0100, Clement Verna wrote:
In an effort to try to spread knowledge on how to do things in the Fedora Infrastructure, let's try to use a How To git repo [0].
Would it be possible to then publish the contents of that repo to https://docs.fedoraproject.org? Or at least https://fedora-infra-docs.readthedocs.io/?
On Thu, Feb 13, 2020, 14:11 Matthew Miller mattdm@fedoraproject.org wrote:
On Tue, Feb 11, 2020 at 05:00:44PM +0100, Clement Verna wrote:
In an effort to try to spread knowledge on how to do things in the Fedora Infrastructure, let's try to use a How To git repo [0].
Would it be possible to then publish the contents of that repo to https://docs.fedoraproject.org? Or at least https://fedora-infra-docs.readthedocs.io/?
The git repo was an easy and simple thing to setup to get started, but I agree that this is not really accessible and user friendly. In my opinion for something like this to be useful it needs to have a decent search functionality which docs.fp.o does not have. The infra-docs supports search so it might be a good candidate, although I think we need to be careful on how we would re-structure this page so that it is easy to navigate.
-- Matthew Miller mattdm@fedoraproject.org Fedora Project Leader _______________________________________________ infrastructure mailing list -- infrastructure@lists.fedoraproject.org To unsubscribe send an email to infrastructure-leave@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/infrastructure@lists.fedorapro...
infrastructure@lists.fedoraproject.org
-
Clement Verna -
Fabrizio -
Leigh Griffin -
Matthew Miller -
Michal Konecny