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: extend development documentation #505

Merged
merged 1 commit into from
Dec 17, 2021
Merged

Conversation

pjbgf
Copy link
Member

@pjbgf pjbgf commented Nov 26, 2021

Fixes #454.

  • Reviewed/tested instructions on Ubuntu 20.04.
  • Extended requirements for make test to run.
  • Added "How to run the controller locally" and "How to install the controller".

Set the name of the container image to be created from the source code. This will be used
when building, pushing and referring to the image on YAML files.

```sh
Copy link
Member

Choose a reason for hiding this comment

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

The alternative shorter way of the below multi-step instruction is the following:

$ IMG=container-registry.com/yourhandle/source-controller TAG=latest BUILD_ARGS=--push \
make docker-build

Copy link
Member Author

Choose a reason for hiding this comment

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

Nice one, I added this as well as the longer version.

@hiddeco hiddeco added the area/docs Documentation related issues and pull requests label Nov 30, 2021
Copy link
Member

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

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

Thanks a lot and 🍎 for first contribution 🙇

Tiny suggestion on the multi-step instruction that can make more efficient use of the available flags in the Makefile. However, I think for documentation purposes the image related variables may still be exported as it provides a better visual separation. We may want to ensure the contributor knows in this case they can be passed as arguments as well.

(The other variable we may want to document is BUILD_PLATFORMS, as it can be trimmed down to the user their specific target architecture for faster builds (and support for BUILDS_ARGS=--load for single architecture images).)

@pjbgf
Copy link
Member Author

pjbgf commented Dec 1, 2021

Thank you for the review @hiddeco. I fixed the points you highlighted, PTAL.

@hiddeco
Copy link
Member

hiddeco commented Dec 17, 2021

Needs a little rebase before it can be merged.

Signed-off-by: Paulo Gomes <paulo.gomes@weave.works>
@pjbgf pjbgf requested a review from hiddeco December 17, 2021 13:48
@hiddeco hiddeco merged commit 1475eca into fluxcd:main Dec 17, 2021
@pjbgf pjbgf deleted the doc-dev.md branch January 19, 2022 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review/extend DEVELOPMENT documentation
2 participants