geode-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF subversion and git services (Jira)" <j...@apache.org>
Subject [jira] [Commented] (GEODE-7205) sync wiki page of Cluster Management Service with Swagger page
Date Tue, 22 Oct 2019 23:13:00 GMT

    [ https://issues.apache.org/jira/browse/GEODE-7205?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16957391#comment-16957391
] 

ASF subversion and git services commented on GEODE-7205:
--------------------------------------------------------

Commit ccbb5deb5675312f4a2bfda1f9171de6b90bb63e in geode's branch refs/heads/feature/GEODE-7258
from Owen Nichols
[ https://gitbox.apache.org/repos/asf?p=geode.git;h=ccbb5de ]

GEODE-7205: add script to auto-generate wiki docs for management REST API (#4194)

[skip ci]

Co-authored-by: Joris Melchior <jmelchior@pivotal.io>

> sync wiki page of Cluster Management Service with Swagger page
> --------------------------------------------------------------
>
>                 Key: GEODE-7205
>                 URL: https://issues.apache.org/jira/browse/GEODE-7205
>             Project: Geode
>          Issue Type: Improvement
>          Components: management, rest (admin)
>            Reporter: Gang Yan
>            Assignee: Owen Nichols
>            Priority: Major
>             Fix For: 1.11.0
>
>          Time Spent: 20m
>  Remaining Estimate: 0h
>
>  
> #WHY
> there are a lot of stuff need to sync-up from Swagger page to wiki,  Including but not
limited to :
> - class
>  - config --> configuration
>  - links
>  - group & groups
>  - experies
> And we do not want to update the wiki page again and again, and also the more we delivered
, the more update we need to publish on wiki page, so we need to find a way to generate wiki
page from Swagger page in programming way.
> #WHAT
> there is a Swagger page and api-docs, everything is there, so we need to find a way to
parse the swagger page to generate Wiki page.
>  1. find input
>  2. find output format on wiki 
>  3. parse the input to output format



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Mime
View raw message