docs: final cleanup - fix all remaining inconsistencies
Fixed: - Badge URLs in README.md (cpfarhood → privilegedescalation) - Repository references in docs/README.md - Old version references in docs (v0.2.0 → v0.2.4) - Tarball filenames in installation guides (0.2.0 → 0.2.4) - Publishing documentation references - Removed remaining emojis from README All documentation now consistently references: - Organization: privilegedescalation - Version: 0.2.4 - No emojis or marketing fluff - Correct tarball checksums Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
This commit is contained in:
+3
-3
@@ -7,7 +7,7 @@ This guide covers how to publish the plugin to NPM, GitHub, and Artifact Hub.
|
|||||||
Before publishing, ensure you have:
|
Before publishing, ensure you have:
|
||||||
|
|
||||||
1. **NPM Account** - Create one at https://www.npmjs.com
|
1. **NPM Account** - Create one at https://www.npmjs.com
|
||||||
2. **GitHub Account** - Already set up (cpfarhood)
|
2. **GitHub Account** - Already set up (privilegedescalation)
|
||||||
3. **Artifact Hub** - Repository already configured (ID: 5574d37c-c4ae-45ab-a378-ef24aaba5b4c)
|
3. **Artifact Hub** - Repository already configured (ID: 5574d37c-c4ae-45ab-a378-ef24aaba5b4c)
|
||||||
|
|
||||||
## Step 1: Initial Setup
|
## Step 1: Initial Setup
|
||||||
@@ -115,7 +115,7 @@ The repository includes automated workflows:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Initialize git (if not already done)
|
# Initialize git (if not already done)
|
||||||
cd /Users/cpfarhood/Documents/Repositories/headlamp-sealed-secrets-plugin
|
cd /Users/privilegedescalation/Documents/Repositories/headlamp-sealed-secrets-plugin
|
||||||
git init
|
git init
|
||||||
git add .
|
git add .
|
||||||
git commit -m "Initial commit: Headlamp Sealed Secrets plugin"
|
git commit -m "Initial commit: Headlamp Sealed Secrets plugin"
|
||||||
@@ -225,7 +225,7 @@ When releasing new versions:
|
|||||||
If the NPM package name is taken, update `package.json`:
|
If the NPM package name is taken, update `package.json`:
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "@cpfarhood/headlamp-sealed-secrets"
|
"name": "@privilegedescalation/headlamp-sealed-secrets"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -241,7 +241,7 @@ See [CHANGELOG.md](CHANGELOG.md) for version history.
|
|||||||
|
|
||||||
### Need Help?
|
### Need Help?
|
||||||
|
|
||||||
1. **📖 Check Documentation First**
|
1. ** Check Documentation First**
|
||||||
- [Troubleshooting Guide](docs/troubleshooting/) - Common issues and solutions
|
- [Troubleshooting Guide](docs/troubleshooting/) - Common issues and solutions
|
||||||
- [User Guide](docs/user-guide/) - Feature documentation
|
- [User Guide](docs/user-guide/) - Feature documentation
|
||||||
- [API Reference](docs/api-reference/generated/) - TypeScript API docs
|
- [API Reference](docs/api-reference/generated/) - TypeScript API docs
|
||||||
@@ -250,10 +250,10 @@ See [CHANGELOG.md](CHANGELOG.md) for version history.
|
|||||||
- [Open Issues](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues)
|
- [Open Issues](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues)
|
||||||
- [Closed Issues](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues?q=is%3Aissue+is%3Aclosed)
|
- [Closed Issues](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues?q=is%3Aissue+is%3Aclosed)
|
||||||
|
|
||||||
3. **💬 Ask the Community**
|
3. ** Ask the Community**
|
||||||
- [GitHub Discussions](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/discussions)
|
- [GitHub Discussions](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/discussions)
|
||||||
|
|
||||||
4. **🐛 Report a Bug**
|
4. ** Report a Bug**
|
||||||
- [Create New Issue](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues/new)
|
- [Create New Issue](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues/new)
|
||||||
- Include: Plugin version, Headlamp version, error messages, steps to reproduce
|
- Include: Plugin version, Headlamp version, error messages, steps to reproduce
|
||||||
|
|
||||||
@@ -281,10 +281,10 @@ Built with:
|
|||||||
|
|
||||||
### Project Resources
|
### Project Resources
|
||||||
- **[Releases](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases)** - Download plugin
|
- **[Releases](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases)** - Download plugin
|
||||||
- 📚 **[Documentation](docs/README.md)** - Complete docs
|
- **[Documentation](docs/README.md)** - Complete docs
|
||||||
- 🐛 **[Issues](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues)** - Bug reports
|
- **[Issues](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues)** - Bug reports
|
||||||
- 💬 **[Discussions](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/discussions)** - Q&A
|
- **[Discussions](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/discussions)** - Q&A
|
||||||
- 📝 **[Changelog](CHANGELOG.md)** - Version history
|
- **[Changelog](CHANGELOG.md)** - Version history
|
||||||
|
|
||||||
### External Resources
|
### External Resources
|
||||||
- **[Headlamp](https://headlamp.dev)** - Kubernetes UI framework
|
- **[Headlamp](https://headlamp.dev)** - Kubernetes UI framework
|
||||||
|
|||||||
+1
-1
@@ -26,7 +26,7 @@ All code is complete, tested, and committed to the `main` branch.
|
|||||||
|
|
||||||
### 1. Create GitHub Repository
|
### 1. Create GitHub Repository
|
||||||
```bash
|
```bash
|
||||||
# On GitHub: Create repository "headlamp-sealed-secrets-plugin" under cpfarhood
|
# On GitHub: Create repository "headlamp-sealed-secrets-plugin" under privilegedescalation
|
||||||
# Then run:
|
# Then run:
|
||||||
git remote add origin https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin.git
|
git remote add origin https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin.git
|
||||||
git push -u origin main
|
git push -u origin main
|
||||||
|
|||||||
+1
-1
@@ -93,7 +93,7 @@ Production deployment guides:
|
|||||||
|
|
||||||
### External Resources
|
### External Resources
|
||||||
|
|
||||||
- **GitHub**: [cpfarhood/headlamp-sealed-secrets-plugin](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin)
|
- **GitHub**: [privilegedescalation/headlamp-sealed-secrets-plugin](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin)
|
||||||
- **Issues**: [Report bugs](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues)
|
- **Issues**: [Report bugs](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/issues)
|
||||||
- **Discussions**: [Ask questions](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/discussions)
|
- **Discussions**: [Ask questions](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/discussions)
|
||||||
- **Headlamp**: [headlamp.dev](https://headlamp.dev)
|
- **Headlamp**: [headlamp.dev](https://headlamp.dev)
|
||||||
|
|||||||
@@ -27,19 +27,19 @@ Download and extract the latest release:
|
|||||||
|
|
||||||
**macOS:**
|
**macOS:**
|
||||||
```bash
|
```bash
|
||||||
curl -LO https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases/download/v0.2.0/headlamp-sealed-secrets-0.2.0.tar.gz
|
curl -LO https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases/download/v0.2.4/headlamp-sealed-secrets-0.2.4.tar.gz
|
||||||
tar -xzf headlamp-sealed-secrets-0.2.0.tar.gz -C ~/Library/Application\ Support/Headlamp/plugins/
|
tar -xzf headlamp-sealed-secrets-0.2.4.tar.gz -C ~/Library/Application\ Support/Headlamp/plugins/
|
||||||
```
|
```
|
||||||
|
|
||||||
**Linux:**
|
**Linux:**
|
||||||
```bash
|
```bash
|
||||||
curl -LO https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases/download/v0.2.0/headlamp-sealed-secrets-0.2.0.tar.gz
|
curl -LO https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases/download/v0.2.4/headlamp-sealed-secrets-0.2.4.tar.gz
|
||||||
tar -xzf headlamp-sealed-secrets-0.2.0.tar.gz -C ~/.config/Headlamp/plugins/
|
tar -xzf headlamp-sealed-secrets-0.2.4.tar.gz -C ~/.config/Headlamp/plugins/
|
||||||
```
|
```
|
||||||
|
|
||||||
**Windows (PowerShell):**
|
**Windows (PowerShell):**
|
||||||
```powershell
|
```powershell
|
||||||
Invoke-WebRequest -Uri https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases/download/v0.2.0/headlamp-sealed-secrets-0.2.0.tar.gz -OutFile headlamp-sealed-secrets-0.2.0.tar.gz
|
Invoke-WebRequest -Uri https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases/download/v0.2.4/headlamp-sealed-secrets-0.2.4.tar.gz -OutFile headlamp-sealed-secrets-0.2.4.tar.gz
|
||||||
# Extract to %APPDATA%\Headlamp\plugins\
|
# Extract to %APPDATA%\Headlamp\plugins\
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -31,8 +31,8 @@ Error loading plugin headlamp-sealed-secrets: Invalid plugin manifest
|
|||||||
|
|
||||||
2. Reinstall from latest release:
|
2. Reinstall from latest release:
|
||||||
```bash
|
```bash
|
||||||
curl -LO https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases/download/v0.2.0/headlamp-sealed-secrets-0.2.0.tar.gz
|
curl -LO https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/releases/download/v0.2.4/headlamp-sealed-secrets-0.2.4.tar.gz
|
||||||
tar -xzf headlamp-sealed-secrets-0.2.0.tar.gz -C ~/Library/Application\ Support/Headlamp/plugins/
|
tar -xzf headlamp-sealed-secrets-0.2.4.tar.gz -C ~/Library/Application\ Support/Headlamp/plugins/
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Restart Headlamp
|
3. Restart Headlamp
|
||||||
|
|||||||
Reference in New Issue
Block a user