Skip to content

Commit

Permalink
Merge pull request #1 from aikdocs/no1
Browse files Browse the repository at this point in the history
this is the first commit
  • Loading branch information
windsonsea authored Nov 13, 2024
2 parents a4cd842 + 93023a3 commit 03d1590
Show file tree
Hide file tree
Showing 3,127 changed files with 207,041 additions and 23 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: "\U0001F6D1 Report a bug in the DaoCloud Enterprise Documents"
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**

A clear and concise description of what the bug is.

**To Reproduce**

Steps to reproduce the behavior:
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

**Expected behavior**

A clear and concise description of what you expected to happen.

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**

Add any other context about the problem here.
123 changes: 123 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
name: Bug Report
description: Create a report to identify and fix a bug
title: "Bug: "
labels: ["bug", "gitauto"]
# assignees: [""]

body:
- type: textarea
id: bug_behavior
attributes:
label: Bug Behavior
description: What is the bug? What is currently happening?
placeholder: "Example: 'When I try to upload a file (over 100MB), the process fails with a timeout error. This disrupts my workflow and causes delays in my project.'"
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs
description: Include any logs such as error objects, stack traces, or console logs.
placeholder: "Example: 'Error: TimeoutError: The request timed out after 30 seconds'"
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Add any screenshots such as error messages or unexpected behavior.
placeholder: "Attach it here"
validations:
required: false

- type: input
id: when_it_occurred
attributes:
label: When It Occurred
description: When did the issue last occur?
placeholder: "Example: 'Jul 10, 2024 12:08:00 AM UTC'"
validations:
required: true

- type: textarea
id: steps_to_reproduce
attributes:
label: Steps to Reproduce
description: How can we reproduce the bug?
placeholder: |
Example:
1. Go to "Upload"
2. Click on "Select File"
3. Choose a large file (over 100MB)
4. Click "Upload"
5. See error
value: |
1.
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: What do you expect to happen?
placeholder: "Example: 'The file should upload successfully without any errors even if it's over 100MB.'"
validations:
required: true

- type: textarea
id: possible_cause
attributes:
label: Possible Cause
description: If you have any idea what might be causing the issue, describe it.
placeholder: "Example: 'The issue may be related to the new file upload library introduced in version 1.2.3.'"
validations:
required: false

- type: input
id: device
attributes:
label: Device
description: Describe your device or server.
placeholder: "MacBook Pro, 14-inch, 2023 (Check in 'About This Mac')"
validations:
required: true

- type: input
id: os
attributes:
label: OS
description: |
Describe your operating system.
- For Mac, check in "About This Mac".
- For Windows, check in "Settings" > "System" > "About".
- For iOS, check in "Settings" > "General" > "About" > "iOS Version".
- For Linux, run `uname -a` in the terminal.
- For your server, specify the provider such as AWS EC2, AWS Lambda, or etc.
placeholder: "Sonoma 14.5"
validations:
required: true

- type: input
id: browser
attributes:
label: Browser
description: |
Describe your browser.
- For Chrome, "Chrome, Version 126.0.6478.127 (Official Build) (arm64)". Check in "3 dots" on the top right > "Help" > "About Google Chrome".
- For Safari, "Safari, Version 17.5 (19618.2.12.11.6)". Check in "Safari" on the top left > "About Safari".
- For non-browser issues, type "Server-side" or "Mobile App".
placeholder: "Chrome, Version 126.0.6478.127 (Official Build) (arm64)"
validations:
required: true

- type: textarea
id: additional_information
attributes:
label: Additional Information
description: Include any other context or information.
placeholder: "Describe it here"
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: ✅ Connect US when your having questions.
url: https://www.daocloud.io
about: If you have questions about DaoCloud product or need support building applicaion, please ask us
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "\U0001F7E1 Request a feature in the DaoCloud Enterprise Documents"
about: If you have feature idea for DaoCloud Enterprise Documents
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**

A clear and concise description of what you want to happen.

**Describe alternatives you've considered**

A clear and concise description of any alternative solutions or features you've considered.

**Additional context**

Add any other context or screenshots about the feature request here.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Feature Request
description: Share your problem and suggest a new feature
title: "Feature Request: "
labels: ["enhancement", "gitauto"]
# assignees: [""]

body:
- type: textarea
id: problem
attributes:
label: Problem
description: What issue are you facing?
placeholder: "Example: 'When I try to upload large files (over 100MB), the process succeeds but takes more than 10 minutes. This disrupts my workflow and causes delays in my project.'"
validations:
required: true

- type: textarea
id: current_solution
attributes:
label: Current Solution
description: How are you currently solving this problem?
placeholder: "Example: 'To work around this, I'm splitting the files into smaller parts (less than 50MB each) and uploading them individually. This is time-consuming and mistake-prone.'"
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: Proposed Solution
description: What do you want to happen?
placeholder: "Example: 'I would like a feature that supports seamless uploading of large files, more than 100MB, without any timeouts or delays. This will help me save time and improve my productivity.'"
validations:
required: true

- type: textarea
id: attachments
attributes:
label: Screenshots or Diagrams
description: Add any screenshots or diagrams that can help us understand the feature request.
placeholder: "Attach it here"
validations:
required: false

- type: textarea
id: additional_information
attributes:
label: Additional Information
description: Include any other information or screenshots.
placeholder: "Describe it here"
validations:
required: false
18 changes: 18 additions & 0 deletions .github/workflows/auto-label-pr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Auto Labels PR

# how usage: https://github.com/marketplace/actions/labeler

on:
- pull_request_target

jobs:
triage:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@v4
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
configuration-path: .github/labeler.yml # update role in this file
33 changes: 33 additions & 0 deletions .github/workflows/auto-size-pr.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Size labeler

on:
- pull_request_target

jobs:
size-labeler:
permissions:
issues: write
pull-requests: write
runs-on: ubuntu-latest
name: Label the PR size
steps:
- uses: codelytv/pr-size-labeler@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
xs_label: "size/xs"
xs_max_size: "9"
s_label: "size/s"
s_max_size: "29"
m_label: "size/m"
m_max_size: "99"
l_label: "size/l"
l_max_size: "499"
xl_label: "size/xl"
xl_max_size: "999"
xll_label: "size/xll"
xll_max_size: "1999"
fail_if_xll: "false"
message_if_xll: >
This PR exceeds the recommended size of 2000 lines.
Please make sure you are NOT addressing multiple issues with one PR.
Note this PR might be rejected due to its size.
69 changes: 69 additions & 0 deletions .github/workflows/corrupted-hyperlink.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# This is a basic workflow to help you get started with Actions

name: find corrupted hyperlink

# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the main branch
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build-test:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2
with:
fetch-depth: 0 # Required for mkdocs to be able to display pages last update info
- uses: actions/setup-python@v2
with:
python-version: 3.x

# Runs a single command using the runners shell
- run: pip install mkdocs-material \
mkdocs-git-revision-date-plugin \
mkdocs-mermaid2-plugin \
mkdocs-rss-plugin \
mkdocs-minify-plugin \
mkdocs-macros-plugin \
mkdocs-git-revision-date-localized-plugin \
mkdocs-awesome-pages-plugin \
mkdocs-redirects \
mkdocs-print-site-plugin \
mkdocs-swagger-ui-tag \
pyyaml

# add custom plugin with pdf support
- run: pip install git+https://github.com/SAMZONG/mkdocs-with-pdf-support-material-v8

# check corrupted hyperlink
- run: pwd
- run: mkdocs build -f docs/zh/mkdocs.yml -d ../../public/ >> zh_build.log
- run: mkdocs build -f docs/en/mkdocs.yml -d ../../public/en/ >> en_build.log
- run: ls -lha
- run: echo "# zh_build.log" >> issue-body.txt
- run: grep -e 'WARNING.*\.md.*contains a link to.*not found' zh_build.log >> issue-body.txt
- run: echo "# en_build.log" >> issue-body.txt
- run: grep -e 'WARNING.*\.md.*contains a link to.*not found' en_build.log >> issue-body.txt

# Create an issue if there are any warnings
- name: Create issue
uses: peter-evans/create-issue-from-file@v2
with:
title: 'Corrupted document hyperlink'
body: |
${{ steps.get_issue_body.outputs.body }}
labels: |
bug
corrupted-hyperlink
assignees: |
windsonsea
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ISSUE_BODY_PATH: ./issue-body.txt
id: get_issue_body
Loading

0 comments on commit 03d1590

Please sign in to comment.