Skip to content

Conversation

@polatengin
Copy link
Member

closes #130

published sample site can be seen here; https://enpolatmsft.github.io/benchpress/

@polatengin polatengin added documentation Improvements or additions to documentation deployment eng milestone1 labels Jan 30, 2023
@polatengin polatengin added this to the v0.1 milestone Jan 30, 2023
@polatengin polatengin self-assigned this Jan 30, 2023
@polatengin polatengin linked an issue Jan 30, 2023 that may be closed by this pull request
@github-actions
Copy link
Contributor

github-actions bot commented Jan 30, 2023

🦙 MegaLinter status: ❌ ERROR

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 9 0 0.15s
✅ ARM arm-ttk 1 0 5.71s
❌ BICEP bicep_linter 26 16 92.47s
✅ COPYPASTE jscpd yes no 4.31s
✅ CSHARP csharpier 58 0 3.6s
✅ CSS stylelint 1 0 1.1s
✅ EDITORCONFIG editorconfig-checker 327 0 0.97s
✅ JSON eslint-plugin-jsonc 12 0 1.85s
✅ JSON jsonlint 9 0 0.22s
⚠️ JSON prettier 12 1 1.37s
✅ JSON v8r 12 0 7.8s
⚠️ MARKDOWN markdownlint 40 33 0.7s
❌ MARKDOWN markdown-link-check 39 11 12.06s
✅ MARKDOWN markdown-table-formatter 40 0 0.36s
✅ POWERSHELL powershell 162 0 420.03s
✅ POWERSHELL powershell_formatter 163 0 260.25s
✅ REPOSITORY gitleaks yes no 0.27s
✅ REPOSITORY secretlint yes no 2.34s
✅ SPELL misspell 327 0 0.1s
✅ XML xmllint 1 0 0.0s
✅ YAML prettier 12 0 0.82s
✅ YAML v8r 12 0 18.66s
✅ YAML yamllint 12 0 0.35s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

Copy link
Contributor

@hattan hattan left a comment

Choose a reason for hiding this comment

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

In addition to inline comments, please provide a readme that explains how the docs-site is build, what are the dependencies (tailwind, astro) and instructions on generating docs locally for contributors.

In addition, we should clearly document the expected conventions in comments.

@polatengin polatengin requested a review from hattan February 16, 2023 21:50
@polatengin polatengin requested a review from marclerwick March 14, 2023 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deployment documentation Improvements or additions to documentation eng milestone1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deploy auto generated docs to GitHub Pages

4 participants