Blame
|
1 | # Project Quickstart |
||||||
| 2 | ||||||||
| 3 | Projects are the working units owned by an AeThex organization. |
|||||||
| 4 | ||||||||
| 5 | | Field | Value | |
|||||||
| 6 | |---|---| |
|||||||
| 7 | | Documentation status | Active | |
|||||||
| 8 | | Applies to | Organizations, teams, and product work | |
|||||||
| 9 | | Last verified | 2026-06-26 | |
|||||||
| 10 | ||||||||
| 11 | ## Before you begin |
|||||||
| 12 | ||||||||
| 13 | You should have: |
|||||||
| 14 | ||||||||
| 15 | - An AeThex identity. |
|||||||
| 16 | - An organization or program responsible for the work. |
|||||||
| 17 | - A clear project purpose and owner. |
|||||||
| 18 | - A decision about whether the project is public, internal, or experimental. |
|||||||
| 19 | ||||||||
| 20 | ## Define the project |
|||||||
| 21 | ||||||||
| 22 | Record: |
|||||||
| 23 | ||||||||
| 24 | 1. Project name and short purpose. |
|||||||
| 25 | 2. Owning organization. |
|||||||
| 26 | 3. Maintainer or team. |
|||||||
| 27 | 4. Repository and deployment surface. |
|||||||
| 28 | 5. Data classification and access requirements. |
|||||||
| 29 | 6. Product maturity. |
|||||||
| 30 | 7. Support and incident route. |
|||||||
| 31 | ||||||||
| 32 | ## Establish permissions |
|||||||
| 33 | ||||||||
| 34 | Use least privilege: |
|||||||
| 35 | ||||||||
| 36 | - Readers can view project information. |
|||||||
| 37 | - Contributors can change project content. |
|||||||
| 38 | - Maintainers can approve and deploy changes. |
|||||||
| 39 | - Administrators control identity, secrets, and destructive operations. |
|||||||
| 40 | ||||||||
| 41 | ## Connect documentation |
|||||||
| 42 | ||||||||
| 43 | Every public project should link to: |
|||||||
| 44 | ||||||||
| 45 | - Its product or service page. |
|||||||
| 46 | - Setup instructions. |
|||||||
| 47 | - Repository when public. |
|||||||
| 48 | - Changelog. |
|||||||
| 49 | - Security/reporting instructions. |
|||||||
| 50 | - Current status surface. |
|||||||
| 51 | ||||||||
| 52 | ## Next steps |
|||||||
| 53 | ||||||||
| 54 | - [[Projects]] |
|||||||
| 55 | - [[Organizations]] |
|||||||
| 56 | - [[Teams]] |
|||||||
| 57 | - [[Permissions]] |
|||||||
| 58 | - [[Documentation Standards]] |
|||||||