-
Notifications
You must be signed in to change notification settings - Fork 81
Description
Problem Statement
The current Akash documentation lacks clear, step-by-step instructions for new providers on how to get audited by the core team. This creates confusion for new providers who want to join the network.
Current Documentation Gaps
-
Missing Process Documentation: The Audited Attributes page explains what audited attributes are but doesn't explain how new providers can get audited.
-
Outdated Information: Some documentation still references the old Discord-based process (contacting @andy01), but the current process uses GitHub issues.
-
No Clear Prerequisites: New providers don't have a clear checklist of requirements before requesting an audit.
Proposed Solution
Add a new documentation page: /docs/providers/provider-audit-process/ or integrate into existing provider docs that includes:
Content to Add:
How to Request Provider Audit
- Link to GitHub Issues
- Issue title format:
[Provider Audit] provider.yourdomain.com - Template to use
Prerequisites Before Audit Request
-
Provider Attributes Configuration
$ provider-services query provider get akash1<YOUR_ADDRESS> -o textMust show:
attributes: - key: host value: akash - key: tier value: community info: email: "[your@email.com](mailto:your@email.com)" website: "yourwebsite.com" -
DNS/Ingress Setup
$ host anything.ingress.yourdomain.com anything.ingress.yourdomain.com has address YOUR_PROVIDER_IP -
Port Configuration
- Ports: 80, 443, 8443, 8444, 30000-32767
- Link to existing firewall documentation
What Happens During Audit
- Timeline expectations (1-3 days typically)
- What the core team tests:
- Provider URI name resolution
- Ingress URI name resolution
- Provider status endpoints
- Deployment functionality
- Network connectivity
- GPU functionality (if applicable)
After Approval
- Signed transaction confirmation
- Provider can now bid on community deployments
- How to verify audit status
Example Implementation
The documentation should reference recent successful audit examples from GitHub issues like:
Impact
This documentation will:
- ✅ Reduce provider onboarding confusion
- ✅ Decrease support requests in Discord
- ✅ Standardize the audit process
- ✅ Improve provider adoption
- ✅ Make the process more discoverable
Suggested Location
Either:
/docs/providers/provider-audit-process/index.md(new page)- Add section to
/docs/providers/intro/index.md - Add section to
/docs/deployments/audited-attributes/index.md