Skip to content

Commit 65d88cb

Browse files
akhismatakhismat
committed
draft PR
Signed-off-by: Anna Khismatullina <[email protected]>
1 parent 287f2f2 commit 65d88cb

File tree

18 files changed

+327
-233
lines changed

18 files changed

+327
-233
lines changed

‎dev/import-tool/docs/huly/example-workspace/Documentation.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
class: document:class:Teamspace
2+
title: Documentation
3+
emoji: 📖
4+
private: false
5+
autoJoin: true
6+
owners:
7+
- [email protected]
8+
members:
9+
- [email protected]
10+
description: Technical documentation and guides

‎dev/import-tool/docs/huly/example-workspace/Documentation/Getting Started.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
class: document:class:Document
3+
title: Getting Started Guide
4+
---
5+
# Getting Started
6+
7+
Welcome to our project! This guide will help you get started with development.
8+
9+
## Setup Steps
10+
11+
1. Clone the repository
12+
2. Install dependencies
13+
3. Set up your environment
14+
15+
## Project Communication
16+
We use Huly for all project communication:
17+
- Team discussions in Virtual Office
18+
- Technical discussions in issue comments
19+
- Documentation in Huly Documents

‎dev/import-tool/docs/huly/example-workspace/Documentation/User Guide.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
class: document:class:Document
3+
title: User Guide
4+
---
5+
# User Guide
6+
7+
Our platform architecture and key components.
8+
9+
## System Overview
10+
11+
<img src="./files/architecture.png" width="800"/>
12+
13+
## Development Workflow
14+
- Code reviews via GitHub integration
15+
- CI/CD status in Huly Activity Feed
16+
- Team sync-ups in Huly Virtual Office

‎dev/import-tool/docs/huly/example-workspace/Documentation/User Guide/Installation.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
class: document:class:Document
3+
title: Installation Guide
4+
---
5+
# Installation
6+
7+
## System Requirements
8+
- Node.js 18 or higher
9+
- Docker Desktop
10+
- Git
11+
12+
## Setup Steps
13+
14+
1. Clone the repository
15+
2. Install dependencies
16+
3. Configure your environment
17+
18+
## Need Help?
19+
Contact @Joe Shmoe for technical support

‎dev/import-tool/docs/huly/example-workspace/Documentation/files/architecture.png

39.3 KB
Loading

‎dev/import-tool/docs/huly/example-workspace/Project Alpha.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
class: tracker:class:Project
2+
title: Project Alpha
3+
identifier: ALPHA
4+
emoji: 🦄
5+
private: false
6+
autoJoin: true
7+
owners:
8+
- [email protected]
9+
members:
10+
- [email protected]
11+
description: Main development project
12+
defaultIssueStatus: Todo

‎dev/import-tool/docs/huly/example-workspace/Project Alpha/1.Project Setup.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
class: tracker:class:Issue
3+
title: Project Setup
4+
status: In Progress
5+
priority: High
6+
assignee: John Doe
7+
estimation: 8
8+
remainingTime: 4
9+
comments:
10+
- author: [email protected]
11+
text: |
12+
Initial infrastructure is ready!
13+
- author: [email protected]
14+
text: |
15+
Great! I'll start working on [Configure CI](./1.Project%20Setup/2.Configure%20CI.md) task now.
16+
- author: [email protected]
17+
text: |
18+
Perfect, don't forget to update [documentation](../Documentation/User%20Guide/Installation.md) when you're done.
19+
attachments:
20+
- ./files/screenshot.png
21+
---
22+
**Initial project infrastructure setup.**
23+
24+
Tasks:
25+
1. Repository setup
26+
2. Configure GitHub integration with Huly
27+
3. Set up CI/CD pipeline using [configuration template](./files/config.yaml)
28+
4. Configure team access and permissions
29+
30+
Daily sync-ups in Huly Virtual Office at 10:00 AM UTC.

‎dev/import-tool/docs/huly/example-workspace/Project Alpha/1.Project Setup/2.Configure CI.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
class: tracker:class:Issue
3+
title: Configure CI Pipeline
4+
status: Todo
5+
priority: High
6+
assignee: Joe Shmoe
7+
estimation: 4
8+
---
9+
Set up CI pipeline with GitHub integration:
10+
- Configure GitHub Actions
11+
- Set up test automation
12+
- Add build status notifications to Huly
13+
- Configure deployment workflow

‎dev/import-tool/docs/huly/example-workspace/Project Alpha/4.Update Docs.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
class: tracker:class:Issue
3+
title: Update Documentation
4+
status: Backlog
5+
priority: Medium
6+
---
7+
Update project documentation in Huly:
8+
- Complete installation guide
9+
- Add troubleshooting section
10+
- Document GitHub integration setup
11+
- Review in next team meeting

‎dev/import-tool/docs/huly/example-workspace/Project Alpha/files/config.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Development environment configuration
2+
server:
3+
port: 3000
4+
host: localhost
5+
6+
database:
7+
host: localhost
8+
port: 5432
9+
name: project_alpha
10+
user: postgres
11+
12+
github:
13+
webhook_url: https://api.github.com/webhooks
14+
branch: master
15+
16+
logging:
17+
level: debug
18+
format: json

‎dev/import-tool/docs/huly/example-workspace/Project Alpha/files/screenshot.png

38.8 KB
Loading

‎dev/import-tool/docs/huly/example-workspace/Project Alpha/files/screenshot/drawing1.json

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{
2+
"class": "drawing:class:Drawing",
3+
"content": [
4+
{
5+
"lineWidth": 4,
6+
"erasing": false,
7+
"penColor": "#0000ff",
8+
"points": [
9+
{ "x": 213, "y": 181.5 },
10+
{ "x": 203, "y": 181.5 },
11+
{ "x": 193, "y": 181.5 },
12+
{ "x": 168, "y": 181.5 },
13+
{ "x": 136, "y": 181.5 },
14+
{ "x": 108, "y": 181.5 },
15+
{ "x": 84, "y": 188.5 },
16+
{ "x": 59, "y": 196.5 },
17+
{ "x": 42, "y": 205.5 },
18+
{ "x": 35, "y": 220.5 },
19+
{ "x": 32, "y": 227.5 },
20+
{ "x": 31, "y": 233.5 },
21+
{ "x": 31, "y": 241.5 },
22+
{ "x": 31, "y": 248.5 },
23+
{ "x": 34, "y": 257.5 },
24+
{ "x": 41, "y": 269.5 },
25+
{ "x": 53, "y": 280.5 },
26+
{ "x": 69, "y": 290.5 },
27+
{ "x": 84, "y": 297.5 },
28+
{ "x": 112, "y": 305.5 },
29+
{ "x": 190, "y": 319.5 },
30+
{ "x": 250, "y": 323.5 },
31+
{ "x": 314, "y": 323.5 },
32+
{ "x": 372, "y": 317.5 },
33+
{ "x": 410, "y": 303.5 },
34+
{ "x": 424, "y": 292.5 },
35+
{ "x": 427, "y": 279.5 },
36+
{ "x": 427, "y": 265.5 },
37+
{ "x": 425, "y": 250.5 },
38+
{ "x": 413, "y": 225.5 },
39+
{ "x": 407, "y": 214.5 },
40+
{ "x": 398, "y": 203.5 },
41+
{ "x": 380, "y": 189.5 },
42+
{ "x": 361, "y": 181.5 },
43+
{ "x": 317, "y": 168.5 },
44+
{ "x": 261, "y": 154.5 },
45+
{ "x": 207, "y": 148.5 },
46+
{ "x": 168, "y": 148.5 },
47+
{ "x": 153, "y": 148.5 },
48+
{ "x": 147, "y": 151.5 },
49+
{ "x": 143, "y": 157.5 },
50+
{ "x": 142, "y": 165.5 },
51+
{ "x": 142, "y": 165.5 }
52+
]
53+
}
54+
]
55+
}

‎dev/import-tool/docs/huly/example-workspace/QMS Documents.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
class: documents:class:OrgSpace
2+
title: QMS Documents
3+
description: Quality Management System Documentation
4+
private: false
5+
owners:
6+
- user1
7+
members:
8+
- user1
9+
qualified: user1
10+
manager: user1
11+
qara: user1

‎dev/import-tool/docs/huly/example-workspace/QMS Documents/[SOP-001] Document Control.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
class: documents:mixin:DocumentTemplate
3+
title: 'Standard Operating Procedure Template'
4+
docPrefix: SOP
5+
category: DOC
6+
author: John Appleseed
7+
owner: John Appleseed
8+
abstract: Template for Standard Operating Procedures
9+
reviewers:
10+
- John Appleseed
11+
approvers:
12+
- John Appleseed
13+
---
14+
# Standard Operating Procedure
15+
16+
## 1. Purpose
17+
[Describe the purpose of the procedure]
18+
19+
## 2. Scope
20+
[Define the scope and applicability]
21+
22+
## 3. Responsibilities
23+
[List key roles and responsibilities]
24+
25+
## 4. Procedure
26+
[Detail the step-by-step procedure]
27+
28+
## 5. References
29+
[List related documents]
30+
31+
## 6. Revision History
32+
[Document revision history]

‎dev/import-tool/docs/huly/example-workspace/QMS Documents/[SOP-001] Document Control/[SOP-002] Document Review.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
class: documents:class:ControlledDocument
3+
title: Document Review Procedure
4+
template: '../[SOP-001] Document Control.md'
5+
author: John Appleseed
6+
owner: John Appleseed
7+
abstract: Procedure for document review and approval process
8+
reviewers:
9+
- John Appleseed
10+
approvers:
11+
- John Appleseed
12+
changeControl:
13+
description: Initial document creation
14+
reason: Need for standardized review process
15+
impact: Improved document quality control
16+
---
17+
# Document Review Procedure
18+
19+
## 1. Purpose
20+
This procedure defines the process for reviewing quality management system documents.
21+
22+
## 2. Scope
23+
Applies to all controlled documents within the QMS.
24+
25+
## 3. Responsibilities
26+
- Document Owner: Responsible for content
27+
- Reviewers: Technical review
28+
- QA Manager: Final approval
29+
30+
## 4. Procedure
31+
1. Author prepares document
32+
2. Technical review
33+
3. QA review
34+
4. Final approval
35+
5. Document release
36+
37+
## 5. References
38+
- Quality Manual
39+
- Document Control Procedure
40+
41+
## 6. Revision History
42+
Rev 0.1 - Initial draft

‎dev/import-tool/docs/huly/example-workspace/QMS Documents/[WI-001] Document Template Usage.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
class: documents:class:ControlledDocument
3+
title: Document Template Usage Guide
4+
template: '[SOP-001] Document Control.md'
5+
author: John Appleseed
6+
owner: John Appleseed
7+
abstract: Work instruction for using document templates
8+
reviewers:
9+
- John Appleseed
10+
approvers:
11+
- John Appleseed
12+
---
13+
# Document Template Usage Guide
14+
15+
## 1. Purpose
16+
Guide users in proper usage of QMS document templates.
17+
18+
## 2. Scope
19+
All personnel creating QMS documentation.
20+
21+
## 3. Procedure
22+
1. Select appropriate template
23+
2. Fill in required sections
24+
3. Submit for review
25+
26+
## 4. Document Review Changes
27+
28+
| Step | Current Text | Updated Text | Comments |
29+
| --- | --- | --- | --- |
30+
| Initial Review | Select a template from library | Select a template that matches your document type | Clarified selection criteria |
31+
| Metadata | Fill in required fields | Complete all required metadata and content fields | Added metadata specification |
32+
| Review Process | Submit for review | Submit document for review according to procedure | Added reference to procedure |
33+
| Approval | Wait for approval | Submit for approval after receiving all reviews | Process detail added |
34+
35+
## 5. References
36+
- [Document Control SOP](./[SOP-001]%20Document%20Control.md)
37+
- [Document Review Procedure](./[SOP-001]%20Document%20Control/[SOP-002]%20Document%20Review.md)

0 commit comments

Comments
 (0)