[DOCS-3044] Transfer MMS Public API documentation to manual Created: 31/Mar/14  Updated: 16/Mar/15  Resolved: 20/May/14

Status: Closed
Project: Documentation
Component/s: Cloud Manager
Affects Version/s: None
Fix Version/s: v1.3.5

Type: Task Priority: Major - P3
Reporter: Michael Benoit Assignee: Sam Kleinman (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Participants:
Days since reply: 9 years, 24 weeks, 1 day ago

 Description   

Transfer the MMS Public API documentation to the MMS Manual.

As discussed, I'll write up a draft of the doc in reStructuredText, and then let you guys handle integrating it with the MMS Manual.



 Comments   
Comment by Githook User [ 02/Sep/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3044: rename blacklists
Branch: next
https://github.com/10gen/mms-docs/commit/dc9eb8604c96bf1b6f9811b0621e36950cd563e9

Comment by Githook User [ 02/Sep/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3044: api documentation, inital import
Branch: next
https://github.com/10gen/mms-docs/commit/f08780ca9d0a1b8a6891dac1b3e019d082460de4

Comment by Githook User [ 19/May/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3044: rename blacklists
Branch: master
https://github.com/10gen/mms-docs/commit/dc9eb8604c96bf1b6f9811b0621e36950cd563e9

Comment by Githook User [ 19/May/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3044: api documentation, inital import
Branch: master
https://github.com/10gen/mms-docs/commit/f08780ca9d0a1b8a6891dac1b3e019d082460de4

Comment by Michael Benoit [ 05/May/14 ]

samk, one small documentation update. Please change all occurrences of blacklist to excludedNamespaces. Thanks.

Comment by Michael Benoit [ 02/May/14 ]

samk, I spoke to cailin.nelson@10gen.com about it today, and she's fine with adding this to the manual whenever it's ready. We can just add a sentence at the top that says it's currently in private beta. So, no need to wait until the 0527 release.

Comment by Michael Benoit [ 02/May/14 ]

That's great news!

There's no rush at the moment. The Public API wont be fully released until the 0527, because some of it depends on the two-factor authentication redesign that's currently underway. So I would hold off on making this available in the MMS Manual until the 27th. This thought only occurred to me this morning.

Comment by Michael Benoit [ 25/Apr/14 ]

OK, I'm done! I officially hand this off to the docs team. Let me know if you want me to walk you through it. Also, here's the updated link to the document in our master branch:
https://github.com/10gen/mms/blob/master/docs/publicApi.rst

A few things to note:

  • There are a couple of comments in the reStructuredText source about small details that are different for SaaS vs. OnPrem. I think there are only two such comments.
  • I'll leave it to you guys to figure out the best way to integrate this into the manual, but I was thinking that you could divide it up something like this:
    • MMS Public API (intro page)
    • Getting Started
    • General Principles
    • A page for each resource:
      • Root Resource
      • Hosts Resource
      • etc.
Comment by Michael Benoit [ 23/Apr/14 ]

This will be coming your way very soon. I just put my draft in code review to be looked at by one of my colleagues. Once that's done. I'll officially hand it off to you.

Comment by Michael Benoit [ 18/Apr/14 ]

We're finishing up some final details with the API, after which I should be able to wrap up the draft of the documentation. I'll post another comment on this ticket when it's ready to go.

Comment by Michael Benoit [ 31/Mar/14 ]

Here's a link to the work in progress:
https://github.com/10gen/mms/blob/feature_MMSP-1482/docs/publicApi.rst

Let me know if there's anything I should do differently to make it as painless as possible to integrate this with the MMS Manual.

Generated at Thu Feb 08 07:44:51 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.