mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-01-22 04:20:18 -06:00
Complete reorganization of project documentation to improve discoverability, navigation, and maintainability. All documentation has been restructured into a clear, role-based hierarchy. ## Major Changes ### New Directory Structure - Created `docs/api/` for API documentation - Created `docs/admin/` with subdirectories: - `admin/configuration/` - Configuration guides - `admin/deployment/` - Deployment guides - `admin/security/` - Security documentation - `admin/monitoring/` - Monitoring and analytics - Created `docs/development/` for developer documentation - Created `docs/guides/` for user-facing guides - Created `docs/reports/` for analysis reports and summaries - Created `docs/changelog/` for detailed changelog entries (ready for future use) ### File Organization #### Moved from Root Directory (40+ files) - Implementation notes → `docs/implementation-notes/` - Test reports → `docs/testing/` - Analysis reports → `docs/reports/` - User guides → `docs/guides/` #### Reorganized within docs/ - API documentation → `docs/api/` - Administrator documentation → `docs/admin/` (with subdirectories) - Developer documentation → `docs/development/` - Security documentation → `docs/admin/security/` - Telemetry documentation → `docs/admin/monitoring/` ### Documentation Updates #### docs/README.md - Complete rewrite with improved navigation - Added visual documentation map - Organized by role (Users, Administrators, Developers) - Better categorization and quick links - Updated all internal links to new structure #### README.md (root) - Updated all documentation links to reflect new structure - Fixed 8 broken links #### app/templates/main/help.html - Enhanced "Where can I get additional help?" section - Added links to new documentation structure - Added documentation index link - Added admin documentation link for administrators - Improved footer with organized documentation links - Added "Complete Documentation" section with role-based links ### New Index Files - Created README.md files for all new directories: - `docs/api/README.md` - `docs/guides/README.md` - `docs/reports/README.md` - `docs/development/README.md` - `docs/admin/README.md` ### Cleanup - Removed empty `docs/security/` directory (moved to `admin/security/`) - Removed empty `docs/telemetry/` directory (moved to `admin/monitoring/`) - Root directory now only contains: README.md, CHANGELOG.md, LICENSE ## Results **Before:** - 45+ markdown files cluttering root directory - Documentation scattered across root and docs/ - Difficult to find relevant documentation - No clear organization structure **After:** - 3 files in root directory (README, CHANGELOG, LICENSE) - Clear directory structure organized by purpose and audience - Easy navigation with role-based organization - All documentation properly categorized - Improved discoverability ## Benefits 1. Better Organization - Documentation grouped by purpose and audience 2. Easier Navigation - Role-based sections (Users, Admins, Developers) 3. Improved Discoverability - Clear structure with README files in each directory 4. Cleaner Root - Only essential files at project root 5. Maintainability - Easier to add and organize new documentation ## Files Changed - 40+ files moved from root to appropriate docs/ subdirectories - 15+ files reorganized within docs/ - 3 major documentation files updated (docs/README.md, README.md, help.html) - 5 new README index files created - 2 empty directories removed All internal links have been updated to reflect the new structure.
147 lines
5.8 KiB
Markdown
147 lines
5.8 KiB
Markdown
# Contributor Covenant Code of Conduct
|
|
|
|
## Our Pledge
|
|
|
|
We as members, contributors, and leaders pledge to make participation in our
|
|
community a harassment-free experience for everyone, regardless of age, body
|
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
identity and expression, level of experience, education, socio-economic status,
|
|
nationality, personal appearance, race, religion, or sexual identity
|
|
and orientation.
|
|
|
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
diverse, inclusive, and healthy community.
|
|
|
|
## Our Standards
|
|
|
|
Examples of behavior that contributes to a positive environment for our
|
|
community include:
|
|
|
|
* Demonstrating empathy and kindness toward other people
|
|
* Being respectful of differing opinions, viewpoints, and experiences
|
|
* Giving and gracefully accepting constructive feedback
|
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
and learning from the experience
|
|
* Focusing on what is best not just for us as individuals, but for the
|
|
overall community
|
|
|
|
Examples of unacceptable behavior include:
|
|
|
|
* The use of sexualized language or imagery, and sexual attention or
|
|
advances of any kind
|
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
* Public or private harassment
|
|
* Publishing others' private information, such as a physical or email
|
|
address, without their explicit permission
|
|
* Other conduct which could reasonably be considered inappropriate in a
|
|
professional setting
|
|
|
|
## Enforcement Responsibilities
|
|
|
|
Community leaders are responsible for clarifying and enforcing our standards of
|
|
acceptable behavior and will take appropriate and fair corrective action in
|
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
or harmful.
|
|
|
|
Community leaders have the right and responsibility to remove, edit, or reject
|
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
decisions when appropriate.
|
|
|
|
## Scope
|
|
|
|
This Code of Conduct applies within all community spaces, and also applies when
|
|
an individual is officially representing the community in public spaces.
|
|
|
|
## Enforcement
|
|
|
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
reported to the community leaders responsible for enforcement at
|
|
[INSERT CONTACT METHOD].
|
|
All complaints will be reviewed and investigated promptly and fairly.
|
|
|
|
All community leaders are obligated to respect the privacy and security of the
|
|
reporter of any incident.
|
|
|
|
## Enforcement Guidelines
|
|
|
|
Community leaders will follow these Community Impact Guidelines in determining
|
|
the consequences for any action they deem in violation of this Code of Conduct:
|
|
|
|
### 1. Correction
|
|
|
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
unprofessional or unwelcome in the community.
|
|
|
|
**Consequence**: A private, written warning from community leaders, providing
|
|
clarity around the nature of the violation and an explanation of why the
|
|
behavior was inappropriate. A public apology may be requested.
|
|
|
|
### 2. Warning
|
|
|
|
**Community Impact**: A violation through a single incident or series of
|
|
actions.
|
|
|
|
**Consequence**: A warning with consequences for continued behavior. No
|
|
interaction with the people involved, including unsolicited interaction with
|
|
those enforcing the Code of Conduct, for a specified period of time. This
|
|
includes avoiding interactions in community spaces as well as external channels
|
|
like social media. Violating these terms may lead to a temporary or permanent
|
|
ban.
|
|
|
|
### 3. Temporary Ban
|
|
|
|
**Community Impact**: A serious violation of community standards, including
|
|
sustained inappropriate behavior.
|
|
|
|
**Consequence**: A temporary ban from any sort of interaction or public
|
|
communication with the community for a specified period of time. No public or
|
|
private interaction with the people involved, including unsolicited interaction
|
|
with those enforcing the Code of Conduct, is allowed during this period.
|
|
Violating these terms may lead to a permanent ban.
|
|
|
|
### 4. Permanent Ban
|
|
|
|
**Community Impact**: Demonstrating a pattern of violation of community
|
|
standards, including sustained inappropriate behavior, harassment of an
|
|
individual, or aggression toward or disparagement of classes of individuals.
|
|
|
|
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
community.
|
|
|
|
## Reporting
|
|
|
|
If you experience or witness unacceptable behavior—or have any other concerns—
|
|
please report it by contacting the community leaders at [INSERT CONTACT METHOD].
|
|
|
|
All reports will be handled with discretion. You may be asked to provide additional
|
|
information to help with the investigation of your report. While we cannot
|
|
guarantee complete confidentiality, we will make every effort to protect your
|
|
privacy and safety.
|
|
|
|
## Addressing Grievances
|
|
|
|
If you feel you have been falsely or unfairly accused of violating this Code of
|
|
Conduct, you may file a grievance by contacting the community leaders at
|
|
[INSERT CONTACT METHOD]. Your grievance will be handled in accordance with our
|
|
existing governing policies.
|
|
|
|
## Additional Resources
|
|
|
|
* [Contributing Guidelines](CONTRIBUTING.md)
|
|
* [Project Documentation](README.md)
|
|
* [Community Guidelines](https://github.com/drytrix/TimeTracker/discussions)
|
|
|
|
## License
|
|
|
|
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
|
|
version 2.0, available at
|
|
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
|
|
|
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
|
enforcement ladder](https://github.com/mozilla/diversity).
|
|
|
|
For answers to common questions about this code of conduct, see the FAQ at
|
|
https://www.contributor-covenant.org/faq. Translations are available at
|
|
https://www.contributor-covenant.org/translations.
|