User talk:Martyav/Sandbox/API:Lists

Thanks for working on this! Here is first round of feedback:

• `list` module is a parameter and so we won't be able to embed it in the docs. Instead you could provide a link https://www.mediawiki.org/w/api.php?action=help&modules=query saying that all list supported modules are in there. Also, List Submodules section that you've linked in the additional notes can be integrated here.
• I like that in the beginning of the documented you've included a nice description about the API module. But, I think it would be nice if we try to integrate this info in various sections wherever appropriate. For example: "Links to individual list submodules can be found below, under the List Submodules section in Additional Notes. A fuller description of list submodules is available here. Most list submodules can be used as generators" could go in API:Documentation.
• Ideally, we don't need to include examples on this page and keep it simple like API:All search modules or API:Properties or API:Meta. The example that is in there is a combination of list and prop which is nice but feels a little out of place. It could be a tutorial of its own, for which I would need to think about a suitable venue. So, I suggest that we get rid of Example and Possible errors section completely.

I'm currently working on your suggestions.

I also closed the pull request since we won't be including additional examples on this page.

@Martyav Thanks for working on this! I ended up re-organizing the content a bit. I think the content is ready to be moved to the main space. But, it requires some understanding of how the translation tags work. You might notice that the original content translation is available in so many languages. Thus while migrating content, we need to make sure that we keep the content enclosed within translation tags intact if we haven't changed it in the re-write.

You could look at this tutorial Help:Extension:Translate/Page translation example  :)

Ok. Thanks!

In the future, should translation tags be considered part of the consistent API page features we're aiming for, or would adding them to pages that don't already have them be considered a separate project?

I'm looking over the translation tutorial now. Most of the text from the original page has been reworded and moved around extensively, with the exception of the section listing off submodules. It is tempting to say, "Let's just translate the Sandbox version whole and add it to the current page", but the overall meaning of many translation units is similar. I do feel a little confused as to how to approach this so as to produce non-breaking changes.

I'm going to set aside time to give this a deep approach tomorrow. I'm already put the contents of the API:Redirects page live.

@Martyav Great! Thanks for making the changes live for API:Redirects :)

Yes, adding translation tags to pages would be part of this project. Understanding how to do so is a bit cumbersome..

And, with this: "Most of the text from the original page has been reworded and moved around extensively, with the exception of the section listing off submodules. It is tempting to say, "Let's just translate the Sandbox version whole and add it to the current page", but the overall meaning of many translation units is similar.." you are completely right. From a quick skimming, it seems like only place where we can retain some translation tags would be for "List query limits" point in "Additional notes" section.

If you've time in the next few days, take a look at the tutorial and see if you get anywhere near to how to approach this ..:)

When I was reading it yesterday, I got hung up on Step 3, "Enabling Translation". Because I'm not a translation admin, I can't mark something for translation and add the automated tags. I did read further and attempt some editing, but I had to stop because I could see this would get complicated and I had a programming workshop later in the evening.