Repository
devops-vn-blog
DevOps VN is a website that shares knowledge about DevOps and Cloud Computing. Contributions are welcome — whether you're translating an article, fixing a typo, improving styling, · License unknown · Maintenance unknown
- License
- Unknown
README
DevOps VN
DevOps VN is a website that shares knowledge about DevOps and Cloud Computing.
Sponsored by Versus Incident
How to Contribute
Contributions are welcome — whether you're translating an article, fixing a
typo, improving styling, or adding a new post. Follow the steps below.
1. Fork and clone
-
Click Fork on the GitHub repository to create your own copy.
-
Clone your fork locally:
git clone https://github.com/<your-username>/devops-vn-blog.git cd devops-vn-blog -
Add the original repository as an
upstreamremote so you can keep your fork
up to date:git remote add upstream https://github.com/VersusControl/devops-vn-blog.git
2. Create a branch
Always work on a descriptive feature branch rather than main:
git checkout -b add/terraform-part-19
# or: fix/typo-networking-osi, chore/update-styles, etc.
3. Make your change
Run the site locally first (see Local Development) so you
can preview your changes at http://127.0.0.1:4000.
Adding or translating an article
-
Create a new Markdown file in
_articles/using a descriptive kebab-case
slug, e.g._articles/terraform-19-workspaces-in-depth.md. -
Add the front matter at the top of the file:
--- layout: post title: "Your Article Title" date: 2024-01-31 author: Your Name subtitle: "A one-line summary shown under the title." tags: [terraform, aws, iac] image: /assets/images/posts/<slug>/cover.png --- -
Put images for the post in
assets/images/posts/<slug>/and reference them
with root-absolute paths, e.g.
.
Theimage:in the front matter is the cover/hero — do not repeat it
inline in the body. -
Use the existing
tagsvalues where possible (terraform,kubernetes,
aws,azure,networking,linux,prometheus, etc.) so the post
appears automatically on the Topics and Tags pages. -
Keep writing style consistent with existing articles and translate content
into clear English.
4. Test your change
Build the site and make sure it compiles with no errors and no broken links or
images:
bundle exec jekyll build
Preview locally and check the affected pages render correctly:
bundle exec jekyll serve
5. Commit and push
Write a clear, imperative commit message:
git add .
git commit -m "Add Terraform Series Part 19: Workspaces in depth"
git push origin add/terraform-part-19
6. Open a Pull Request
- Go to your fork on GitHub and click Compare & pull request.
- Target the
mainbranch ofVersusControl/devops-vn-blog. - Describe what you changed and why. Include screenshots for visual
changes. - Make sure the build passes; a maintainer will review and merge.
Once merged into main, the site is rebuilt and deployed automatically (see
Deployment).
Project Structure
_config.yml # Site configuration
_layouts/ # base, home, post, page templates
_articles/ # Blog posts (translated articles go here)
assets/css/main.css # Styles
assets/images/ # Images (author photo, post images)
index.md # Home page
about.md # About page
topics.md # Topics / series overview
.github/workflows/deploy.yml # GitHub Pages deployment