Hi All, Can we think of an offline tool to update the documentation from github.
What I am thinking is, 1. Pack all the documentation with products, taken at the build time from our doc github location 2. Offline tool to update the docs from our download location as a connector 3. Time to time we update the docs (as a connector) on the store. 4. The docs are then served over HTTP , with Tomcat, not via API at the product. Customers can include calling this tool as one step in their CI/CD pipeline. Advantages, a) Someone has to register with our sites to get updates on the docs. This is a much better way to track the product usage than the product usage tracking tool implemented by the WUM team. b). We do not pay for on Github account for OSS usages Cheers, Ruwan A On Tue, May 12, 2020 at 12:01 PM Sathya Bandara <sat...@wso2.com> wrote: > Hi all, > > We are in the process of implementing a side panel help guide in the dev > portal which will show a preview of related documents to the user as he > navigates through the dev portal. More info on this can be found in [1]. > > Originally we thought to use Github REST API to retrieve the docs and its > sitemap. However when accessing the Github API, it has a rate limit of 60 > requests per hour for unauthenticated requests [2]. > > We had a discussion with the team and as a solution to this limitation, we > decided to introduce a new server API. In the API we will use OAuth based > authentication to Github which increases the rate limit to to 5000 > requests/hour. > > Following will be the notations of the new API > > > ** GET api/server/v1/docs/sitemap* > This will return the entire sitemap for WSO2 Documentation. If it is > required to retrieve the sitemap for a particular portal, we have added the > support to specify it in a query param. > E.g. > > > *api/server/v1/docs/sitemap?portal=Dev+Portal* > > ** POST api/server/v1/docs* > This will be the API to retrieve docs. Here we need to pass any key > retrieved from the sitemap in the request body, in-order to retrieve the > document corresponding to that key. > > Highly appreciate your thoughts and suggestions. > > [1] "[Iam-dev] [Dev Portal] [UX] Side panel design for the WSO2 Identity > Server Developer Portal" > [2] https://developer.github.com/v3/#rate-limiting > > Thanks, > Sathya > -- > Sathya Bandara > Senior Software Engineer > Blog: https://medium.com/@technospace > WSO2 Inc. http://wso2.com > Mobile: (+94) 715 360 421 > > -- Ruwan Abeykoon | Director/Architect | WSO2 Inc. (w) +947435800 | Email: ruw...@wso2.com
_______________________________________________ Architecture mailing list Architecture@wso2.org https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
