max123kl / j4.docs Goto Github PK

This Issue refers to PR: #joomla/joomla-cms#38650 (comment)

• Document to update: done Yes/no
• Text drafted
• Text ready for review
• Ask for review by PR's author

should be completed

We will start our journey from the Help screens project. This documentation have top priority between all. Before making the follow information "official", I wanted to consult with you for get a feedback.

1. We have not defined which platform will be used for the new documentation, but It is clear that we will not continue using Mediawiki. Docusaurus look as a good candidate, but still not all the few peoples involve and with interested in helping, totally agree about it. One of the important things for the management of this documentation, is the ability to reuse created documents. In mediawiki it is handled with Chunks, here they would be .md files
   But while we look for it, we can start to migrate the Help screens content.

2. The new format for the Help content will be Markdown. It is a global format which allows us flexibility when choosing how we are going to visualize it.

3. I will ask for a independient repository for Help screens. I think the user/administrator documentation not need be in the same place as the Help screens, because thinking loud, even Github Pages is enough to display this Help documentation, and the proxy of the help buttons can fetch easy these pages or the .md files. I think separating this documentation gives us more flexibility in it.

4. The images used in the help screens will be located in a folder of name assets in the same path than the file being viewed. The images will follow some guidlines already defined in Image Naming Guidelines. A updated images guidelines will be hosted in the Wiki tab of the repository.

5. We will follow the same pattern so far in the current Help screens, about the amount of image to use. @ceford did a good job in this and I agree with him, while less image we need use, the better for the Help screens.

6. We will take care of the multilingual aspect of the help screens. However, as the procedure for this is directly related to the platform that we are going to use to display the help screens, for now we will focus in the english version. And to be realistic, we are too few now to think that we can also do the documentation in another language. So for the moment, it will only be a plan to be achieved in the future, if we manage to get the documentation on track.

7. Help screens have links pointing to other help screens. To facilitate our work as much as possible, once the structure of this documentation is defined, we will begin to document from the lower levels, in this way we will be able to relate the Help screens once we reach higher levels in the structure.
   Also, we will rely on a Kanban Board (Github Project) where we will enter the links that could not be completed in the document that is being migrated. In this way we can take into account which links to complete as we progress.

8. It is necessary to attend the new entries in the documentation of the Help screens. I will ask for configure (if is possible) the joomla-bot, so that once a PR is marked with the label "Documentation required" an entry is created in the Help screen repository with the PR. From here, we will have to update mediawiki and the new documentation if it is already created.

9. We will seek to promote the repository to earn contributions. We will accept PR in the repository with contributions to the migration process.

10. The feedback will be handled in the Issue tab of the repository. For example, a good feedback is to see what they think about which platform we should use for the Help screens.

Structure of the documentation

Each Help screen is located on specific views and this views have a defined path to it. I think the expected behavior would be to define a structure similar to this path. So I propose the following:

├── Components
│   ├── Banners
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── Contacts
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── News Feeds
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── Smart Search
│   │   ├── MainView.md
│   │   ├── edit.md
│   ├── Tags
│   │   ├── MainView.md
│   │   ├── Edit.md
├── Modules
│   ├── Site modules
│   │   ├── MainView.md
│   │   ├── ModuleNameEdit.md
│   ├── Administrator modules
│   │   ├── MainView.md
│   │   ├── ModuleNameEdit.md
├── Plugins
│   ├── MainView.md
│   ├── PluginNameEdit.md
├── Content
│   ├── Articles.md
│   ├── ArticlesEdit.md
│   ├── FeaturedArticles.md
│   ├── Media
│   │   ├── MainView.md
├── Categories
│   ├── MainView.md
│   ├── CategoryEdit.md
├── Fields
│   ├── Fields.md
│   ├── FieldsGoup.md
│   ├── FieldsEdit.md
├── Users
│   ├── Manage
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── Groups
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── AccessLevels
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── UsersNote
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── Privacy
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── MassEmailUsers.md
│   ├── Messaging.md
├── Menu
│   ├── Menus.md
│   ├── MenuItems.md
│   ├── Edit.md
├── Configuration
│   ├── ConfigurationExtensionName.md
│   ├── Global.md
├── Install
│   ├── Extensions.md
│   ├── Discover.md
│   ├── Language.md
├── Maintenance
│   ├── ClearCache.md
│   ├── Database.md
│   ├── GlobalCheckIn.md
│   ├── Warnings.md
│   ├── InstallationMessages.md
│   ├── SystemInformation.md
├── Languages
│   ├── Languages.md
│   ├── ContentLanguages.md
│   ├── LanguageOverride.md
├── Manage
│   ├── Redirects
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── ScheduledTasks
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── Extensions.md
├── Update
│   ├── Joomla.md
│   ├── Extensions.md
│   ├── UpdateSites.md
├── Templates
│   ├── TemplatesStyles
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── Templates
│   │   ├── MainView.md
│   │   ├── Edit.md
│   ├── MailTemplates.md

New Tutorial required
In J3 Docs Custom Fields are part of a series.
For other required tutorials refer to https://github.com/max123kl/J4.docs/blob/main/J4_JDocs/Supporting_Documents/j4x_custom_fields_tutorial_series.md

• Started
• Proof Read
• Ready for Translation

This document is ready to be marked for translation:

https://docs.joomla.org/JDOC:Page_Markup_for_Translation

• Add translate tags.
• Mark for translation.
• Translate into ... and add a comment?

One tag at the top after the <noinclude> ...</noinclude> line, and one at the bottom before(?) the noinclude lines there. Then mark for translation. Try translation - the code blocks should not be translated.

Defining Labels

currently there are these labels are defined

I have added three of them myself, the others are standard in new repos.
In order to be able to filter incoming contributions better, we need a customised selection of meaningful labels here.

Every collaborator on this repo should be able to edit the tasks in this issue.
Visitors and viewers interested in contributing are invited to comment.

Tasks (ordered by highest priority)

• Define the structure of folders and file for the Help screens
• ...
• ...
• ...
• ...
• creating templates for new PRs
• creating templates for new Issues
• ...
• proposal to create a bot for ...
• #21

Each task should have its own issue

Document Purpose

This is the first of series of tutorials about the different types of Custom Fields in Joomla! 4.

Instructions

A series exists for Joomla 3. Follow the format to recreate and align with the Joomla 4 version.

Supporting Information

A list of Joomla 3 links can be found at https://github.com/max123kl/J4.docs/blob/main/J4_JDocs/Supporting_Documents/j4x_custom_fields_tutorial_series.md

• Started
• Document text complete
• Screenshots complete
• Translate tags added
• Proof read
• Ready to translate

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...