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.

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

docs: add developer docs for chartsvc and chart-repo #775

Merged

Conversation

prydonius
Copy link
Contributor

@prydonius prydonius commented Oct 30, 2018

The sources for these tools are in the Monocular repository, this adds
documentation on how to develop these tools for Kubeapps from that
repository.

fixes #754

The sources for these tools are in the Monocular repository, this adds
documentation on how to develop these tools for Kubeapps from that
repository.
Copy link
Contributor

@andresmgot andresmgot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't this documentation live in the Monocular repo?


### Running in development

#### Option 1: Using Telepresence (recommended)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this guide only have one option so I guess we can skip the heading

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, thanks!


This builds the `chart-repo` Docker image.

### Running in development
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't we just point here to the monocular repo? We are having duplicated documentation

Also this is likely to get outdated since the source code of this tool is not in this repo.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #775 (comment).

Also this is likely to get outdated since the source code of this tool is not in this repo.

But how often do we need to change the development workflow?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that we don't update them very often

@prydonius
Copy link
Contributor Author

shouldn't this documentation live in the Monocular repo?

These commands are in the context of testing those tools against Kubeapps - so they reference the Deployment names of kubeapps-internal-chartsvc, etc. I think it's useful to have this here as it is kind of confusing otherwise

@andresmgot
Copy link
Contributor

I know, it just seemed a bit weird to have those docs here. In any case they are adapted and are easy enough so I am fine having them here.

@prydonius prydonius merged commit 4b31938 into vmware-tanzu:master Oct 30, 2018
@prydonius prydonius deleted the 754-chartsvc-chart-repo-dev-docs branch October 30, 2018 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Developer environment documentation (now that chart services are in Monocular)
2 participants