Skip to content

Fix documentation typos and add explicit permissions to workflows#20

Draft
Copilot wants to merge 4 commits intomasterfrom
copilot/improve-docs-and-workflows
Draft

Fix documentation typos and add explicit permissions to workflows#20
Copilot wants to merge 4 commits intomasterfrom
copilot/improve-docs-and-workflows

Conversation

Copy link
Copy Markdown

Copilot AI commented Dec 28, 2025

Clean up repository documentation and harden workflow security by adding explicit permission declarations.

Changes

Documentation (12 typos fixed across 10 files)

  • Fixed spacing typos: from[Materialfrom [Material (icons.md, customize-theme.md)
  • Fixed spelling errors: preferedpreferred (2 release changelogs), neccessarynecessary (kubernetes installation), wetherwhether (v1.9.0 changelog)
  • Fixed duplicate words: the thethe, to toto, signed-in in tosigned-in to, that that'sthat it's
  • Fixed grammar issues: it's ownits own, you youryour

Workflow Permissions (21 files)
Added explicit permissions: declarations following least-privilege principle:

  • CI/CD workflows: contents: read for verification, packages: write where needed for publishing
  • PR/API workflows: Scoped pull-requests: write, actions: read/write as required
  • Sync workflows: contents: write + pull-requests: write for automated commits
  • Automation: Minimal permissions (issues: write, pull-requests: write) for bots

Example change:

name: CI
on:
  pull_request:
    paths-ignore:
      - 'microsite/**'

permissions:
  contents: read

jobs:
  # ...

Aligns with GitHub security best practices and OpenSSF Scorecard recommendations by eliminating implicit default permissions.

Original prompt

lets improve the small tweaks or typos in docs , workflows which will help me gain popularity in the commnuity for fixing this and lets not mkae new things jnust ckean up a lil bit which are not necessary and and secure the things porperly , and make the workflows secure and improve them which will create a good imapct of mine in community


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

- Fixed typo: "from[Material" -> "from [Material" in icons.md
- Fixed typo: "prefered" -> "preferred" in release changelogs (2 files)
- Added missing permissions declarations to 21 GitHub workflows for security hardening
  - Added appropriate read-only permissions where needed
  - Added write permissions only where required for workflow operations
  - Follows GitHub security best practices for workflow permissions

Co-authored-by: Ayushmore1214 <194600182+Ayushmore1214@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation and workflows for clarity and security Fix documentation typos and add explicit permissions to workflows Dec 28, 2025
Copilot AI requested a review from Ayushmore1214 December 28, 2025 05:48
@Ayushmore1214
Copy link
Copy Markdown
Owner

@copilot lets clean and improve the docs of this whole repo first all .md files you look for mistakes

Copy link
Copy Markdown
Author

Copilot AI commented Dec 28, 2025

@copilot lets clean and improve the docs of this whole repo first all .md files you look for mistakes

I'll perform a comprehensive cleanup of all markdown files in the repository. I found several typos and formatting issues to fix:

  1. Typos found:

    • "neccessary" → "necessary" in kubernetes installation docs
    • "from[Material" → "from [Material" (spacing issue) in customize-theme.md
  2. Previous fixes already applied:

    • "prefered" → "preferred" in release changelogs (2 files)
    • "from[Material" → "from [Material" in icons.md

Working on fixes now...

Copilot AI and others added 2 commits December 28, 2025 06:00
- Fixed "neccessary" -> "necessary" in kubernetes installation docs
- Fixed "from[Material" -> "from [Material" (spacing) in customize-theme.md
- Fixed "the the" -> "the" in scaffolder-backend changelog
- Fixed "to to" -> "to" in ADOPTERS.md
- Fixed "signed-in in to" -> "signed-in to" in threat-model.md
- Fixed "it's own" -> "its own" in catalog-import changelog
- Fixed "you your" -> "your" in root-http-router.md

Co-authored-by: Ayushmore1214 <194600182+Ayushmore1214@users.noreply.github.com>
- Fixed "that that's" -> "that it's" in software-catalog references.md
- Fixed "wether" -> "whether" in v1.9.0-changelog.md

Co-authored-by: Ayushmore1214 <194600182+Ayushmore1214@users.noreply.github.com>
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