Page MenuHomePhabricator

[Epic] Clean up ORES documentation
Closed, ResolvedPublic

Event Timeline

Halfak updated the task description. (Show Details)
Halfak added a subscriber: awight.

@awight I've been thinking about what will appear at https://mediawiki.org/wiki/ORES. Why would we put anything there rather than just having it in the README.md at https://github.com/wiki-ai/ores?

I'm sure that would be fine. The wiki page would potentially enable translation, but that's not a problem we have at this point.

Subpages and embedded images in the readme will probably have to live in a docs/ directory, and I'm not sure what Markdown support looks like. Seems to be a sort of clumsy notation that requires the image to be hosted somewhere, c.f. http://stackoverflow.com/questions/14494747/add-images-to-readme-md-on-github

I'd also ask, what are the advantages of documenting in the readme file? Self-containedness, for one. I'm not sure which is going to enable wider collaboration, or be more accessible.

I wonder if we could do a good mixture.

So, we have:

I just extended https://etherpad.wikimedia.org/p/ORES_docs_split to include these two additional documentation spaces.

We can use .wiki files in github. Let me grab an example

@Ladsgroup and I were looking at the etherpad and we realized that mediawiki.org is in a weird spot because the extension/beta feature directs users to the MediaWiki.org pages. But our general user-facing documentation is on Meta. @awight, I'm wondering what you think about this problem. Should we move our user-facing documentation from Meta?

Halfak renamed this task from Clean up ORES service documentation to [Epic] Clean up ORES service documentation.Feb 16 2017, 3:55 PM
Halfak added a project: Epic.

@Eugene233 feel free to use this task instead of T174858 for a guide of updating docs

Halfak renamed this task from [Epic] Clean up ORES service documentation to [Epic] Clean up ORES documentation.Mar 27 2018, 2:20 PM
Halfak updated the task description. (Show Details)
Harej triaged this task as Medium priority.Apr 2 2019, 9:48 PM