docs: rewrite scripts README now that migration is complete
All checks were successful
/ test (push) Successful in 3s
All checks were successful
/ test (push) Successful in 3s
Signed-off-by: jnsamyak <samyak.jn11@gmail.com>
This commit is contained in:
parent
26278a8bf3
commit
fd8b4048fc
1 changed files with 5 additions and 11 deletions
16
README.md
16
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Fedora Release Engineering Scripts (New Structure)
|
||||
# Fedora Release Engineering Tooling Repository
|
||||
|
||||
This directory contains the reorganized structure for Fedora Release Engineering scripts, designed for better maintainability and clarity.
|
||||
This directory contains the Fedora Release Engineering scripts, organized by function for maintainability and clarity.
|
||||
|
||||
## 📁 Directory Structure
|
||||
|
||||
|
|
@ -13,20 +13,14 @@ This directory contains the reorganized structure for Fedora Release Engineering
|
|||
- **[utilities/](utilities/)** - General-purpose helper scripts
|
||||
- **[misc/](misc/)** - Uncategorized or legacy scripts
|
||||
|
||||
## 🔧 Migration Status
|
||||
|
||||
**⚠️ This is the new directory structure under development.**
|
||||
|
||||
Scripts are being migrated from the flat `scripts/` directory to this organized structure. See [CONVENTIONS.md](CONVENTIONS.md) for naming standards and migration guidelines.
|
||||
|
||||
## 📖 Getting Started
|
||||
|
||||
1. Review [CONVENTIONS.md](CONVENTIONS.md) for naming and organization standards
|
||||
2. Check individual directory READMEs for specific tool documentation
|
||||
3. Use the directory structure to quickly locate relevant scripts
|
||||
3. Use the directory structure to locate relevant scripts quickly
|
||||
|
||||
## 🔗 Related
|
||||
|
||||
- Original scripts: `../scripts/` (legacy structure)
|
||||
- Conventions: [CONVENTIONS.md](CONVENTIONS.md)
|
||||
- Issues: [fedora-releng repository](https://forge.fedoraproject.org/releng/tickets/issues)
|
||||
- Issues: [fedora-releng issues repository](https://forge.fedoraproject.org/releng/tickets/issues)
|
||||
- Chat: [#releng:fedoraproject.org (Matrix)](https://matrix.to/#/#releng:fedoraproject.org)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue