You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Trying to summarize everything spoken, and in the form of a report for ourselves
Workflow
With the possibility of a repository for the documentation within the organization, we all agree so far to carry out the task management through Github Projects (Kanban boards).
Migration of the docs content
I think we all agree too, that making an effort to migrate the current content of the documentation to markdown, which is a format globally recognized, lays a good foundation for a possible future migration of the mediawiki platform.
Notice, I am talking about migrating the content to .md files, not about deciding and migrating mediawiki to a new platform (this decision is still not clear since the subject has been introduced on several occasions and there is no clear consensus among all).
In my opinion, we should only make an effort to migrate the documentation corresponding to the current version of the CMS. The documentation of previous versions I think we should leave it as a historical archive hosted in mediawiki.
Use of Issue section
In my opinion, I think we should leave this section for people outside the team. A way of communication and feedback. Ideas, questions like "I want to contribute to... and I don't know which file to edit".
Use of Pull Request section
I think we should leave this section for its current use, suggest changes. In this way, someone who is going to contribute creates a pull request with the changes made, and after being reviewed by the team, they are approved and merged.
If used like this, we must have to create some simple guidelines, which can be followed by the person who is going to contribute.
Use of Wiki section
This section can be useful for a Q/A format about how contribute to the documentation. What is the workflow for approve changes to the documentation...something like this. But this is not clear yet, is just a idea
Structure of the documentation inside the repository
We need to define as soon as possible, the structure that the repository will have with the documentation. @max123kl an @ceford you both are the most with knowledge about the current mediawiki structure, and can better define or suggest the structure to use in this repository. It does not mean that we should use the same structure, but you do know what NOT to do.
But a starting point is how @ceford structure it at https://jdocmanual.org/
I will edit this issue each time we agree in something or a idea come ups. So we have a way of follow up what we talk along the way...
The text was updated successfully, but these errors were encountered:
Trying to summarize everything spoken, and in the form of a report for ourselves
Workflow
With the possibility of a repository for the documentation within the organization, we all agree so far to carry out the task management through Github Projects (Kanban boards).
Migration of the docs content
I think we all agree too, that making an effort to migrate the current content of the documentation to markdown, which is a format globally recognized, lays a good foundation for a possible future migration of the mediawiki platform.
Notice, I am talking about migrating the content to .md files, not about deciding and migrating mediawiki to a new platform (this decision is still not clear since the subject has been introduced on several occasions and there is no clear consensus among all).
In my opinion, we should only make an effort to migrate the documentation corresponding to the current version of the CMS. The documentation of previous versions I think we should leave it as a historical archive hosted in mediawiki.
Use of Issue section
In my opinion, I think we should leave this section for people outside the team. A way of communication and feedback. Ideas, questions like "I want to contribute to... and I don't know which file to edit".
Use of Pull Request section
I think we should leave this section for its current use, suggest changes. In this way, someone who is going to contribute creates a pull request with the changes made, and after being reviewed by the team, they are approved and merged.
If used like this, we must have to create some simple guidelines, which can be followed by the person who is going to contribute.
Use of Wiki section
This section can be useful for a Q/A format about how contribute to the documentation. What is the workflow for approve changes to the documentation...something like this. But this is not clear yet, is just a idea
Structure of the documentation inside the repository
We need to define as soon as possible, the structure that the repository will have with the documentation. @max123kl an @ceford you both are the most with knowledge about the current mediawiki structure, and can better define or suggest the structure to use in this repository. It does not mean that we should use the same structure, but you do know what NOT to do.
But a starting point is how @ceford structure it at https://jdocmanual.org/
I will edit this issue each time we agree in something or a idea come ups. So we have a way of follow up what we talk along the way...
The text was updated successfully, but these errors were encountered: