Page MenuHomePhabricator

[Epic] Clean up ORES documentation
Closed, ResolvedPublic

Event Timeline

Halfak created this task.Oct 24 2016, 2:53 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 24 2016, 2:53 PM
Halfak added a project: ORES.EditedOct 24 2016, 2:54 PM
Halfak updated the task description. (Show Details)
Halfak added a subscriber: awight.

@awight I've been thinking about what will appear at Why would we put anything there rather than just having it in the at

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.

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 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 is in a weird spot because the extension/beta feature directs users to the 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 claimed this task.Oct 27 2016, 2:37 PM
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.
Halfak moved this task from Active to On Deck on the Machine Learning Platform (Current) board.
Zppix added a comment.Sep 5 2017, 3:38 PM

@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)
awight removed a subscriber: awight.Mar 21 2019, 4:00 PM
Harej triaged this task as Medium priority.Apr 2 2019, 9:48 PM
Halfak removed Halfak as the assignee of this task.May 18 2020, 5:10 PM