Welcome to the openKylin Documentation Platform, Here you will find comprehensive resources about openKylin.
The openKylin Community (hereinafter referred to as "the Community") is a global open-source community jointly established by enterprises, non-profit organizations, associations, academic institutions, research institutes, and individual developers. Founded on principles of openness, voluntariness, equality, and collaboration, the Community adopts transparent and open governance to strengthen open-source collaborative development.
Participation & Contribution
openKylin welcomes and encourages participation from everyone, including but not limited to:
- Information Dissemination: Request our articles or share news on our platform.
- Events: Co-organize seminars, exhibitions, or gatherings.
- Collaboration: Join SIGs (Special Interest Groups) for co-development.
Contact Us
We welcome contributions through multiple channels. For all communication methods, see:Community Communication，Join us to foster a positive technical ecosystem!
Explore Further：
Responsible Team: docs SIG (Documentation Special Interest Group)
The openKylin Community docs SIG is dedicated to improving community documentation, helping users better utilize the openKylin system. Our primary work involves creating various documentation types, including but not limited to tutorials and troubleshooting guides.
Main Documentation Repository
FAQ Documentation Standards
Mobile Users Note: Due to Gitee's responsive limitations, mobile devices default to the README file. Access full repository content at: Mobile Repository Directory
- 陌生人
- chipo
- AICloudOpser
- delong1998
- Collect openKylin-related issues and document verified solutions
- Create practical tutorials applicable to openKylin environment
- Develop troubleshooting guides and technical documentation
Writing Standards
- Maintain clarity and simplicity; use technical terms only when necessary
- User-focused documentation should prioritize practical scenarios and solutions
- Ensure technical accuracy without exaggeration or misleading statements
- Focus on stable, tested methodologies; avoid deprecated technologies
- Exclude personal information, proprietary content, or legally restricted material
- Accommodate novice users with detailed step-by-step procedures
- Include title, author, and creation date in all documents
- Prohibit offensive language, politically sensitive terms, advertisements, or illegal content
Technical Specifications
- File Management:
- Use concise file/folder names with underscore separators (e.g., Community_Structure.md)
- Apply .md extension with UTF-8 encoding (without BOM header)
- Media Assets:
- Store images in categorized directories adjacent to documents
- Optimal dimensions: ≤820px width, ≈640px height (≤150KB .png format)
- Use original or royalty-free images to prevent copyright issues
- Employ descriptive naming (avoid numerical sequences)
- Linking:
- Prefer relative paths for internal repository links
- Minimize absolute HTTP paths unless referencing external resources
Repository Protocols
- Branch Management:
- SIG members: Use dev- branches (e.g., dev-moshengren)
- Non-SIG contributors: Fork repository → modify in dev branch → submit PR
- Main Branch Rules:
- master branch accepts PRs only from dev branches
- Direct pushes to master prohibited
- Translation Workflow:
- Place English translations in /en/ directories
- Full translations require forked repository PRs (no lightweight PRs)
- Minor translation edits may use lightweight PRs
Participation Methods
- SIG Members:
- Create feature branches following dev- convention
- Submit changes via pull requests after local development
- External Contributors:
- Fork repository → modify in dev branch → submit PR
- Pre-submission checks:
- Verify compliance with [Content Requirements](#Content Requirements)
- Check for existing work via Issues
- Joining SIG:
Support Resources
- Markdown assistance available via mailing list
- SIG members provide format conversion support
- Propose new topics through Issue tickets
All documentation defaults to CC BY-SA 4.0 license. Alternate CC licenses may be specified per document.
Include this copyright notice at document end:
Copyright Notice: Originally authored by <Author>, modified by <Contributor>.
Licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
Redistribution requires attribution and link to source material.