search

max123kl / J4.docs

Joomla 4.x Documentations preliminary tasks
GNU General Public License v2.0
0 stars 3 forks source link

Document for translation #2

Open ceford opened 1 year ago

ceford commented 1 year ago

This document is ready to be marked for translation:

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

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.

max123kl commented 1 year ago

The idea is to have checkboxes as reminder

ceford commented 1 year ago

I am not clear what you have in mind here. Was I supposed to provide some checkboxes when creating the issue?

max123kl commented 1 year ago

I believe that using check boxes will help to communicate which tasks have to be done. It can also be used to signal whether they are finished or not. You don't need to write a long explanation then. It would be perfect if we could use the experiences to create a template for new issues.

This does not only apply to translations. Documents that need an update could also be classified in this way.

carlitorweb commented 1 year ago

@max123kl is not better define first if the joomla repo will be open us? In this way we cant copy/paste all the work we plan do here. But I agree we can plan what we will put in a repo like this one. For what will be the Issues tab, the Pull Request tab. We will use discussions, annd the Projects tab

ceford commented 1 year ago

I believe that using check boxes will help to communicate which tasks have to be done. It can also be used to signal whether they are finished or not. You don't need to write a long explanation then. It would be perfect if we could use the experiences to create a template for new issues.

This does not only apply to translations. Documents that need an update could also be classified in this way.

@max123kl Can we treat my checkboxes above as an experiment? Do the first task and check it. I have left that to you as a workflow experiment. You can do as many of the tasks as you like.

ceford commented 1 year ago

@max123kl is not better define first if the joomla repo will be open us? In this way we cant copy/paste all the work we plan do here. But I agree we can plan what we will put in a repo like this one. For what will be the Issues tab, the Pull Request tab. We will use discussions, annd the Projects tab

@carlitorweb I have been reading some of the PRs. In many cases what is required is quite vague. I don't think copy and paste is necessary. In any case we can see the PRs and copy/paste anything useful for documentation.

ceford commented 1 year ago

An example from this PR: https://github.com/joomla/joomla-cms/pull/38650

Documentation Changes Required

The documentation needs to be amended to contain how to implement this feature for third party finder plugins.

max123kl commented 1 year ago

@carlitorweb My idea with this repo is that we can test everything we want to do in the Joomla repo here first. There might be a few restrictions, as I only have a free account. This way, we avoid disturbing Joomla.

If you have an idea for an action/script or a project board, it should be possible to implement it here. With a PR, your idea can then be merged and tested. As soon as we think we are ready to go into "production mode", this repo can become the ownership of Joomla and we only have to make minor adjustments.

max123kl commented 1 year ago

@ceford For each document that needs editing, we should always start a new issue, this way we prevent a task list in an issue from getting too big and keep track of it, even if many issues are open. I am starting a new issue for this PR: At the same time, I will assign the edit to myself, which can also be changed, if you think anyone other can't work on it. In the title of the issue, I will use the square brackets to indicate to which part of the documentation this issue contributes.

Since I have set all three of us, you, @carlitorweb and @alann60 as collaborators, we should all have write permissions in the repo.

We can create any label that may help us to filter.

You will see our post is mentioned in the PR comments at joomla-cms.

alann60 commented 1 year ago

I had a thought on the checklist items mentioned above.

I notice a project has been added. Would it make sense that instead of a checklist on the Issue, those checklist items are columns on the project board?

For me, I would use the project board. I can't do anything on that board though.

ceford commented 1 year ago

Added a checklist of tasks to the first comment describing the issue.

max123kl commented 1 year ago

For me, I would use the project board. I can't do anything on that board though.

I'm not very familiar with the project function yet. @carlitorweb pointed out a few things to me last night, but I was too tired to understand everything right away. Obviously, there's still a lot of work to be done to make it work. I also gave you admin rights. The two of you should agree on the best way to integrate the board into the workflow.