Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add external documentation #11

Open
3 of 5 tasks
dcseifert opened this issue Sep 19, 2019 · 1 comment
Open
3 of 5 tasks

Add external documentation #11

dcseifert opened this issue Sep 19, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation S Small issue
Projects
kelon
Milestone
Kelon release v0.3.0

Comments

@dcseifert
Copy link
Contributor

dcseifert commented Sep 19, 2019 •
edited

Description

In order to enable other developers to get familiar with the codebase as fast as possible, there should be a detailed godoc of the project.
It would be also helpful to provide a Swagger-UI for all exposed endpoints of the RestProxy.

Outcome

  • Godoc of the entire codebase
  • Swagger-API Specification
  • Documentation plugin development and integration process
  • Extended README (at least "Setup" & "Getting Started")
  • Official docs
@dcseifert dcseifert added the S Small issue label Sep 19, 2019
@dcseifert dcseifert added this to the Capability test milestone Sep 19, 2019
@dcseifert dcseifert self-assigned this Sep 19, 2019
@dcseifert dcseifert added this to Backlog in kelon via automation Sep 19, 2019
@dcseifert dcseifert moved this from Backlog to Development in kelon Oct 11, 2019
@dcseifert
Copy link
Contributor Author

Plugin documentation is blocked by #31

@dcseifert dcseifert moved this from Development to Backlog in kelon Dec 30, 2019
@dcseifert dcseifert removed their assignment Jul 16, 2021
@dcseifert dcseifert added the documentation Improvements or additions to documentation label Jul 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation S Small issue
Projects
kelon
  
Backlog
Milestone
Kelon release v0.3.0
Development

No branches or pull requests
1 participant
@dcseifert