Skip to content

Commit 028027d

Browse files
authored
Merge pull request #8 from tech-notes-hub/feature/add-blog-website
Feature/add blog website
2 parents b312c17 + 5897342 commit 028027d

File tree

124 files changed

+21362
-87
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+21362
-87
lines changed
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Update Markdown Frontmatter
2+
3+
on:
4+
push:
5+
paths:
6+
- 'docs/**/*.md'
7+
- 'i18n/**/*.md'
8+
pull_request:
9+
paths:
10+
- 'docs/**/*.md'
11+
- 'i18n/**/*.md'
12+
schedule:
13+
# Run at 00:00 UTC every Monday
14+
- cron: '0 0 * * 1'
15+
# Allow manual runs from GitHub interface
16+
workflow_dispatch:
17+
18+
jobs:
19+
update-frontmatter:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v3
24+
with:
25+
# Fetch full history to allow creating commits
26+
fetch-depth: 0
27+
28+
- name: Setup Node.js
29+
uses: actions/setup-node@v3
30+
with:
31+
node-version: '18'
32+
cache: 'npm'
33+
34+
- name: Install dependencies
35+
run: npm install gray-matter glob
36+
37+
- name: Run update script
38+
run: |
39+
chmod +x tools/update-frontmatter.js
40+
node tools/update-frontmatter.js
41+
42+
- name: Check for changes
43+
id: git-check
44+
run: |
45+
git diff --exit-code || echo "changes=true" >> $GITHUB_OUTPUT
46+
47+
- name: Commit changes if any
48+
if: steps.git-check.outputs.changes == 'true'
49+
run: |
50+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
51+
git config --local user.name "github-actions[bot]"
52+
git add -A
53+
git commit -m "chore: update markdown frontmatter [skip ci]"
54+
55+
- name: Push changes
56+
if: steps.git-check.outputs.changes == 'true'
57+
uses: ad-m/github-push-action@master
58+
with:
59+
github_token: ${{ secrets.GITHUB_TOKEN }}
60+
branch: ${{ github.ref }}

.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ dist/
1414
downloads/
1515
eggs/
1616
.eggs/
17-
lib/
1817
lib64/
1918
parts/
2019
sdist/
@@ -67,7 +66,7 @@ coverage.xml
6766
*.rej
6867

6968
# Ignore public site build if using static site generator (optional)
70-
public/
69+
# public/
7170
.cache/
7271

7372
# Ignore Markdown preview temp files (e.g., Typora)
@@ -88,3 +87,6 @@ docker-compose.override.yml
8887
.env
8988
!.env.example
9089
docker/environments/databases/.env
90+
91+
# Not follow website
92+
!website/

CODE_OF_CONDUCT.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Tech Notes Hub Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender characteristics, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [CONTACT EMAIL]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
44+
45+
## Summary
46+
47+
* Treat everyone with respect and courtesy
48+
* Gracefully accept constructive feedback
49+
* Focus on helping others and growing the community
50+
* Don't use offensive language or imagery
51+
* Don't harass, threaten, or discriminate against anyone
52+
* If you witness inappropriate behavior, report it to project maintainers

CODE_OF_CONDUCT_vi.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Quy tắc Ứng xử của Tech Notes Hub
2+
3+
## Cam kết của chúng tôi
4+
5+
Nhằm thúc đẩy một môi trường mở và thân thiện, chúng tôi - những người đóng góp và duy trì dự án - cam kết đảm bảo việc tham gia vào dự án và cộng đồng của chúng tôi là một trải nghiệm không quấy rối cho tất cả mọi người, bất kể tuổi tác, kích thước cơ thể, khuyết tật, dân tộc, đặc điểm giới tính, bản dạng và biểu hiện giới tính, trình độ kinh nghiệm, quốc tịch, ngoại hình cá nhân, chủng tộc, tôn giáo, hoặc bản dạng và khuynh hướng tình dục.
6+
7+
## Tiêu chuẩn của chúng tôi
8+
9+
Các ví dụ về hành vi góp phần tạo ra môi trường tích cực bao gồm:
10+
11+
* Sử dụng ngôn ngữ chào đón và hòa nhập
12+
* Tôn trọng các quan điểm và kinh nghiệm khác nhau
13+
* Nhã nhặn chấp nhận phê bình mang tính xây dựng
14+
* Tập trung vào điều tốt nhất cho cộng đồng
15+
* Thể hiện sự đồng cảm với các thành viên khác trong cộng đồng
16+
17+
Các ví dụ về hành vi không thể chấp nhận từ người tham gia bao gồm:
18+
19+
* Việc sử dụng ngôn ngữ hoặc hình ảnh mang tính gợi dục và sự chú ý hoặc tiến triển tình dục không được chào đón
20+
* Trolling, bình luận xúc phạm/miệt thị, và tấn công cá nhân hoặc mang tính chính trị
21+
* Quấy rối công khai hoặc riêng tư
22+
* Công bố thông tin cá nhân của người khác, chẳng hạn như địa chỉ vật lý hoặc điện tử, mà không được phép rõ ràng
23+
* Các hành vi khác có thể hợp lý được coi là không phù hợp trong môi trường chuyên nghiệp
24+
25+
## Trách nhiệm của chúng tôi
26+
27+
Người duy trì dự án có trách nhiệm làm rõ các tiêu chuẩn về hành vi có thể chấp nhận được và được mong đợi sẽ thực hiện các hành động khắc phục phù hợp và công bằng để đáp lại bất kỳ trường hợp hành vi không thể chấp nhận nào.
28+
29+
Người duy trì dự án có quyền và trách nhiệm xóa, chỉnh sửa hoặc từ chối nhận xét, commit, mã, chỉnh sửa wiki, issues và các đóng góp khác không phù hợp với Quy tắc Ứng xử này, hoặc tạm thời hoặc vĩnh viễn cấm bất kỳ người đóng góp nào vì các hành vi khác mà họ cho là không phù hợp, đe dọa, xúc phạm hoặc có hại.
30+
31+
## Phạm vi
32+
33+
Quy tắc Ứng xử này áp dụng trong cả không gian dự án và không gian công cộng khi một cá nhân đại diện cho dự án hoặc cộng đồng của dự án. Ví dụ về việc đại diện cho một dự án hoặc cộng đồng bao gồm việc sử dụng địa chỉ email chính thức của dự án, đăng thông qua tài khoản mạng xã hội chính thức, hoặc làm đại diện được chỉ định tại một sự kiện trực tuyến hoặc ngoại tuyến. Đại diện của một dự án có thể được người duy trì dự án xác định và làm rõ thêm.
34+
35+
## Thực thi
36+
37+
Các trường hợp hành vi lạm dụng, quấy rối hoặc không thể chấp nhận khác có thể được báo cáo bằng cách liên hệ với nhóm dự án tại [EMAIL LIÊN HỆ]. Tất cả khiếu nại sẽ được xem xét và điều tra, và sẽ dẫn đến phản hồi được coi là cần thiết và phù hợp với hoàn cảnh. Nhóm dự án có nghĩa vụ duy trì tính bảo mật đối với người báo cáo về một sự cố. Các chi tiết cụ thể hơn về chính sách thực thi có thể được đăng riêng.
38+
39+
Người duy trì dự án không tuân theo hoặc thực thi Quy tắc Ứng xử một cách thiện chí có thể phải đối mặt với hậu quả tạm thời hoặc vĩnh viễn do các thành viên lãnh đạo khác của dự án quyết định.
40+
41+
## Ghi nhận
42+
43+
Quy tắc Ứng xử này được điều chỉnh từ [Contributor Covenant](https://www.contributor-covenant.org), phiên bản 1.4, có tại https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
44+
45+
## Tóm tắt
46+
47+
* Đối xử với mọi người bằng sự tôn trọng và lịch sự
48+
* Chấp nhận các góp ý mang tính xây dựng một cách nhã nhặn
49+
* Tập trung vào việc giúp đỡ người khác và phát triển cộng đồng
50+
* Không sử dụng ngôn ngữ hoặc hình ảnh xúc phạm
51+
* Không quấy rối, đe dọa hoặc phân biệt đối xử với bất kỳ ai
52+
* Nếu bạn chứng kiến hành vi không phù hợp, hãy báo cáo cho người quản lý dự án

CONTRIBUTING.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,24 @@ Before submitting, ensure:
113113
## 📁 File & Folder Naming Conventions
114114

115115
* Use lowercase and hyphens for file and folder names: `graph_traversal.md` (except for code files like C# using PascalCase such as `GraphTraversal.cs`, or Java using CamelCase like `GraphTraversal.java`)
116-
* For translations, add language suffix: `graph_traversal_vi.md`
116+
* For translations, add language suffix: `graph_traversal_vi.md`, but no suffix is needed if in the /i18n/[language_code]/ folder
117117
* Notes should be grouped by docs folders (e.g., `docs/algorithms/`, `docs/aws/`, `docs/design-patterns/`)
118118

119+
### 📂 Code Snippets Structure
120+
121+
Code snippets must follow this directory structure for proper display on the website:
122+
123+
```
124+
snippets/[category]/[topic-name]/[filename].[extension]
125+
```
126+
127+
Examples:
128+
- `snippets/algorithms/graph-traversal/graph_traversal.py`
129+
- `snippets/devops/ci-cd/ci-cd.sh`
130+
- `snippets/databases/mongodb/mongodb_query.js`
131+
132+
The `[topic-name]` folder must match the slug of your blog post for snippets to appear automatically. All files inside this folder will be displayed as code snippets on the corresponding blog post page.
133+
119134
## 🤝 Code of Conduct
120135

121136
Be respectful, open, and constructive in all interactions. We're building a friendly and inclusive learning space for all developers.

0 commit comments

Comments
 (0)