Skip to content

Doc update jul24 #88

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

Merged
merged 2 commits into from
Jul 14, 2024
Merged

Doc update jul24 #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8d5b39
update on git ignore file to avoid local venv settings
SamYuan1990 Jul 10, 2024
ef6883e
update document and disable markdown hook as image pull fail
SamYuan1990 Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ kube-prometheus/
.vscode/
.idea/
*.iml
bin/
lib/python3.12
pyvenv.cfg

# Logs
logs
Expand Down
18 changes: 9 additions & 9 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ repos:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/markdownlint/markdownlint.git
rev: v0.13.0
hooks:
- id: markdownlint_docker
name: Markdownlint Docker
description: Run markdown lint on your Markdown files using the project docker image
language: docker_image
files: \.(md|mdown|markdown)$
entry: markdownlint/markdownlint
#- repo: https://github.com/markdownlint/markdownlint.git
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure why the image pull fails. But, Rather than disable what about changing this to the same as what's in Kepler

Note that the following file is also needed: https://github.com/sustainable-computing-io/kepler/pull/1555/files#diff-7acf5910ecddb0a88c58debaedb129a30ebad965e878f6ebba3dad5a4fd8758a

Or I can create a separate PR... WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

I created a PR #91

# rev: v0.13.0
# hooks:
#- id: markdownlint_docker
#name: Markdownlint Docker
#description: Run markdown lint on your Markdown files using the project docker image
#language: docker_image
#files: \.(md|mdown|markdown)$
#entry: markdownlint/markdownlint
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.10.0.1
hooks:
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,15 @@ Will setup container runtime on your host instance.

## Startup

**note**: in 2024 July, we decoupled cluster config with kind cluster setup, so that we allow this repo to set up a existing cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

Notes should be preceded by >


1. Modify kind [config](./kind/manifests/kind.yml) to make sure `extraMounts:` cover
the linux header and BCC.
2. To setup local env run:

```bash
./main.sh up
./main.sh config
```

3. To tear down local env run:
Expand All @@ -67,6 +70,7 @@ Will setup container runtime on your host instance.

```sh
./main.sh up
./main.sh config
```

## Container registry
Expand Down