Skip to content

Doc/add some doc about make #498

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
Merged
merged 2 commits into from
Sep 13, 2023
Merged

Doc/add some doc about make #498

merged 2 commits into from
Sep 13, 2023

Conversation

smoser
Copy link
Contributor

@smoser smoser commented Sep 8, 2023

  • Add some documentation to Makefile and doc/hacking.md.

    The docker.io bandwidth limit can easily stop a developer from being
    able to build or test docker. Even without the limit, docker.io
    is much slower than a local zot or docker repository.

    Add documentation on how to set the makefile variable
    STACKER_DOCKER_BASE.

    Also add information about 'make test' and individual test files.

  • Create a 'test' target separate from 'check'

    This just allows you to run 'make test'. Previously the only
    way to run test from make was to call 'make check' which require
    running lint also.

@smoser
Copy link
Contributor Author

smoser commented Sep 8, 2023

You can see the rendered doc/hacking.md https://github.com/smoser/stacker/blob/doc/add-some-doc/doc/hacking.md

@smoser
fix: Create a 'test' target separate from 'check'
792cf2d 
This just allows you to run 'make test'.  Previously the only
way to run test from make was to call 'make check' which require
running lint also.

Signed-off-by: Scott Moser <smoser@brickies.net>
@smoser
docs: Add some documentation to Makefile and doc/hacking.md
8611c08 
The docker.io bandwidth limit can easily stop a developer from being
able to build or test docker.  Even without the limit, docker.io
is much slower than a local zot or docker repository.

Add documentation on how to set the makefile variable
STACKER_DOCKER_BASE.

Also add information about 'make test' and individual test files.

Signed-off-by: Scott Moser <smoser@brickies.net>
@smoser
Copy link
Contributor Author

smoser commented Sep 13, 2023

bump.
I know there was a request in another channel that "All docs have to be ported over to the stackerbuild.io docs website".

a.) I'm not sure how to do that, please let me know how.
b.) i don't necessarily think that developer documentation (like HACKING.md) should live somewhere other than git
c.) if there is no magic sync of stuff in doc/ to stackerbuild.io, then we're really just making work for ourselves. Having multiple sources of documentation maintained by stacker is just asking for inconsistencies.

My suggestion is:
a. keep developer documentation (doc related to modifying or building code) in git only
b. get rid of user doc in the tree or make make something automatically sync to stackerbuild.io so things aren't out of sync.

@smoser smoser merged commit bcc5009 into project-stacker:main Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hallyn hallyn hallyn approved these changes

@rchincha rchincha Awaiting requested review from rchincha rchincha is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@smoser @hallyn