diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..073e50f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +## Description + + + +## Checklist + +- [ ] Links tested and verified +- [ ] Spelling and grammar checked +- [ ] Previewed changes locally +- [ ] Follows conventional commit format + +## Additional Context + + +--- + +See [CONTRIBUTING.md](../CONTRIBUTING.md) for contribution guidelines. diff --git a/.github/workflows/link-checker.yml b/.github/workflows/link-checker.yml new file mode 100644 index 0000000..0558407 --- /dev/null +++ b/.github/workflows/link-checker.yml @@ -0,0 +1,21 @@ +name: Link Checker + +on: + pull_request: + paths: + - '**.md' + +jobs: + link-check: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Check links + uses: lycheeverse/lychee-action@v2 + with: + args: --verbose --no-progress '**/*.md' + fail: true + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml new file mode 100644 index 0000000..0f5fa19 --- /dev/null +++ b/.github/workflows/markdown-lint.yml @@ -0,0 +1,18 @@ +name: Markdown Lint + +on: + pull_request: + paths: + - '**.md' + +jobs: + markdown-lint: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Lint markdown files + uses: DavidAnson/markdownlint-cli2-action@v18 + with: + globs: '**/*.md' \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..79eb21e --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +# Ignore editor and OS-specific files +.DS_Store +Thumbs.db +.idea/ +.vscode/ +*.swp +*.swo +*.bak +*.tmp +~$* \ No newline at end of file diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..1dd8622 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,6 @@ +{ + "default": true, + "MD013": false, + "MD033": false, + "MD041": false +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..db6c6ae --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing + +This repository contains the Itential organization profile displayed at . + +## Getting Started + +We welcome contributions to improve our organization profile. This includes: + +- Adding new repositories to the ecosystem table +- Updating repository descriptions +- Fixing typos or broken links +- Improving clarity and messaging + +## Workflow + +This repository uses the **Fork and Pull** model: + +1. **Fork** this repository to your GitHub account +2. **Clone** your fork locally +3. **Create** a feature branch (`docs/update-description`) +4. **Make** your changes to `profile/README.md` +5. **Test** all links and preview changes +6. **Commit** using conventional commit format (see below) +7. **Push** to your fork +8. **Open** a Pull Request + +## Commit Format + +Use conventional commits: + +- `docs: add new repository to ecosystem table` +- `docs: update LinkedIn badge URL` +- `fix: correct broken link to blog` + +Format: `: ` (≤50 chars, imperative mood) + +## Review Process + +- All PRs require link checking and markdown linting to pass +- Changes will be reviewed by maintainers +- Updates should maintain the existing format and structure + +## Questions? + +Contact us at diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..8a9e80f --- /dev/null +++ b/profile/README.md @@ -0,0 +1,52 @@ +## Itential + +Innovation is unlocked when we **Collaborate, Contribute, and Create** together. Here you can find open-source tools, ready to use community assets, _battle-tested_ collections used to deploy validated Itential architectures, and more. + +

+Blog  +LinkedIn  +Twitter/X  +YouTube +

+ +--- + +## 🛠️ Open Source Ecosystem + +Explore our growing collection of open-source tools and integrations: + +| Repository | Description | +|------------|-------------| +| **[itential-mcp](https://github.com/itential/itential-mcp)** | MCP Server for Itential Platform integration | +| **[ipsdk](https://github.com/itential/ipsdk)** | Itential Python SDK for platform automation | +| **[itential.deployer](https://github.com/itential/itential.deployer)** | Ansible collection for deploying validated architectures | +| **[itential.iag5](https://github.com/itential/itential.iag5)** | Ansible collection for Itential Gateway v5 | +| **[iap-helm](https://github.com/itential/iap-helm)** | Kubernetes Helm charts for Itential Automation Platform | +| **[iag5-helm](https://github.com/itential/iag5-helm)** | Kubernetes Helm charts for Itential Gateway v5 | +| **[assets](https://github.com/itential/assets)** | Ready to import Community Assets | + +--- + +## 🤝 Contributing + +We welcome contributions from the community! Each repository contains specific contribution guidelines and code of conduct. Please review the individual repository documentation before submitting pull requests. + +For general inquiries about contributing to Itential open-source projects, contact us at [opensource@itential.com](mailto:opensource@itential.com). + +--- + +## 📄 License + +Our open-source projects are licensed under various licenses including Apache-2.0 and GPL-3.0. Please refer to individual repository LICENSE files for specific terms. + +--- + +
+ +**Unify your tools, teams, and environments with a platform built to streamline network and infrastructure operations at scale.** + +_Itential Platform | Accelerate. Standardize. Scale._ + +[Blog](https://itential.com/blog) • [Learn More](https://itential.com) • [Careers](https://itential.com/careers) + +