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

Get a godoc reference #28

Open
3 tasks
drpaneas opened this issue Sep 23, 2020 · 0 comments
Open
3 tasks

Get a godoc reference #28

drpaneas opened this issue Sep 23, 2020 · 0 comments
Labels
CI/CD DevOps related work documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone
CI/CD

Comments

@drpaneas
Copy link
Collaborator

drpaneas commented Sep 23, 2020 •
edited
Loading

Description

Godoc is the official place to go for Golang packages documentation. Find out how we can include our romie packages into it.

Acceptance Criteria

  • Read https://go.dev/about#adding-a-package
  • Create an entry for our code
  • Find out if we need to do anything to update it or it gets updated by itself. Otherwise we need to make part of the CI.

** Alternative **: In worst case scenario, check if https://github.com/marketplace/actions/godoc-action works as expected
@drpaneas drpaneas added documentation Improvements or additions to documentation good first issue Good for newcomers CI/CD DevOps related work labels Sep 23, 2020
@drpaneas drpaneas added this to the Sprint 1 - CI/CD milestone Sep 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CI/CD DevOps related work documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
CI/CD
Development

No branches or pull requests
1 participant
@drpaneas