Skip to content

DEE-94 - add missing setup documentation#198

Open
str11ngfello wants to merge 3 commits into
mainfrom
DEE-94/add-missing-docs
Open

DEE-94 - add missing setup documentation#198
str11ngfello wants to merge 3 commits into
mainfrom
DEE-94/add-missing-docs

Conversation

@str11ngfello

Copy link
Copy Markdown

What's changed?

  • Add docs for Chef Habitat dependency - creating an origin and personal access token and exporting the token to host machine environment
  • Running molecule create once dependencies are installed
  • Add TOC

@str11ngfello str11ngfello requested a review from anthonyra March 31, 2025 19:46
Comment thread README.md
@str11ngfello str11ngfello marked this pull request as ready for review April 1, 2025 19:14
Comment thread README.md
## Install pipx
For local development of Chef Habitat packages you’ll want to create your own Chef Habitat Builder account. It’s similar to a GitHub or a Docker repo, but stores Habitat Packages. (.hart files)

Set up your builder account at [bldr.habitat.sh](http://bldr.habitat.sh). (You’ll need a GitHub account to sign up)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The URL for the Habitat Builder site should use HTTPS instead of HTTP for better security. Please update the link from http://bldr.habitat.sh to https://bldr.habitat.sh to ensure secure connections when users access the site.

Suggested change
Set up your builder account at [bldr.habitat.sh](http://bldr.habitat.sh). (Youll need a GitHub account to sign up)
Set up your builder account at [bldr.habitat.sh](https://bldr.habitat.sh). (You'll need a GitHub account to sign up)

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

Comment thread README.md

### Create Personal Access Token

Head to your profile and create an personal access token. Set this token to the environment on your host machine.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

There's a minor grammatical error in this sentence: "create an personal access token" should be "create a personal access token" since "personal" begins with a consonant sound.

Suggested change
Head to your profile and create an personal access token. Set this token to the environment on your host machine.
Head to your profile and create a personal access token. Set this token to the environment on your host machine.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

Comment thread README.md

# Install pipx

We leverage pipx to ensure that all programs and librarys we depend on can be installed globally and isolated with venvs out of the box. It's also supported by MacOS, Linux, and Windows.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

There's a small typo in this sentence - "librarys" should be spelled "libraries".

Suggested change
We leverage pipx to ensure that all programs and librarys we depend on can be installed globally and isolated with venvs out of the box. It's also supported by MacOS, Linux, and Windows.
We leverage pipx to ensure that all programs and libraries we depend on can be installed globally and isolated with venvs out of the box. It's also supported by MacOS, Linux, and Windows.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

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.

2 participants