Re: question about publishing to API portal

Jeff Brower
 

Vikram-

Ok understood, that makes sense. Redoc is good. Thanks.

-Jeff

We are hosting this for the community in our cloud as there was no
precedent to follow. We used the following open source

https://github.com/Redocly/redoc/blob/master/README.md

Easiest way is to express API in a popular format using protobuf and
generate swagger definitions. I can ask my engineer to help with launch
once the community approves the updated set.

As developer APIs shall consume Infra APIs so there might be a need to
build a validation cycle in community labs. We are still in process to
figure that out.


On Wed, May 20, 2020 at 6:21 PM Jeff Brower <@jbrower> wrote:

Vikram-

Ok got it. At some point in the future when there are APIs approved and
can be added, how is the page accessed / edited ? That's what I need to
know, so I can come up with publishing / editing method for API
subcommittee guys.

Thanks.

-Jeff

api.akraino.org as domain suggests is for final approved APIs by the
community.

Working docs go under

https://wiki.akraino.org/display/AK/Infrastructure+API+Work+Stream


On Wed, May 20, 2020 at 6:09 PM Jeff Brower <@jbrower>
wrote:

Brett-

I'm referring to:

api.akraino.org

How to edit that page ?

-Jeff

Hi Jeff,
+ adding theapi@... mail list to advise.

https://wiki.akraino.org/display/AK/API+Sub-committee may be the best
place to
start?
Thanks!

Brett






On Wed, May 20, 2020 9:54 PM, Jeff Brower @jbrower
wrote:
Brett-




I'm helping with API architecture diagrams, maps, and other items that
we (API
subcommittee) want to add to the API portal (api.akraino.org).




What is your recommended method for publishing Powerpoint, MindMap,
and
other
doc types to the API portal URL ? I know HTML very well, so I have no

problem to export PowerPoint to HTML and then upload to a site and
integrate
with what's already there. But I'm worried to lead subcommittee guys

down a path where they need a lot of HTML knowledge and what they
publish
becomes difficult to maintain.




Are you using a hosted method for the portal; i.e. something similar
to
SquareSpace, Wix, Wordpress, etc ? Is there an ftp backend where we
can

upload HTML pages ?




Thanks for any advice.




-Jeff









Brett PrestonThe Linux Foundation+1 (971) 303-9030
@bprestonlf
Google Talk:bpreston@...: bprestoncf





Join api@lists.akraino.org to automatically receive all group messages.