1278385 - Better documentation for azure-entities

Status: RESOLVED FIXED

(Taskcluster :: Services, defect)

Description

[Dustin J. Mitchell [:dustin] (he/him)]

https://github.com/taskcluster/azure-entities/blob/master/src/entity.js has a little bit of documentation in it, but doesn't really tell you how to use entities unless you read the code in depth (and it isn't easy code to understand!).  The README is empty.

Andrea, I can work on writing this documentation, but where do you think I should put it so that it can be factored into the taskcluster documentation?  This is a library we have written, rather than a service.

Maybe I should just put it in the project's README.md, and then import that from the docs site?

Comment 1

[Andrea Del Rio]

As far as I know, Kristel is the one working on the docs site.

Comment 2

[Dustin J. Mitchell [:dustin] (he/him)]

Ugh, yes, so sorry.. I forgot a lot of things over the last week!

Comment 3

[Brian Stack [:bstack]]

I think this would work really nicely with kt's new readme stuff on the docs site. Maybe a third subsection in the Reference section? Platform/Core/Libraries?

Once our work is further progressed we can do this from a postpublish hook or something like that with real jsdocs and such, but I think that your plan for now sounds great.

Comment 4

[Dustin J. Mitchell [:dustin] (he/him)]

https://github.com/taskcluster/azure-entities/pull/11

Comment 5

[[github robot]]

Commit pushed to master at https://github.com/taskcluster/azure-entities

https://github.com/taskcluster/azure-entities/commit/85aa7a967943c55731b476b16c1296aa9b149081
Merge pull request #11 from djmitche/readme

Bug 1278385: Add README

Comment 6

[Dustin J. Mitchell [:dustin] (he/him)]

https://docs.taskcluster.net/reference/libraries/azure-entities