Skip to content

Feature/update interview guides - #9

Open
mchittineni wants to merge 123 commits into
litu54:mainfrom
mchittineni:feature/update-interview-guides
Open

Feature/update interview guides#9
mchittineni wants to merge 123 commits into
litu54:mainfrom
mchittineni:feature/update-interview-guides

Conversation

@mchittineni

@mchittineni mchittineni commented Aug 6, 2026

Copy link
Copy Markdown

Pull Request / Branch Summary: feature/update-interview-guides

1. Overview & Goal

This update introduces repository-wide standardization for interview question guides, adds native Obsidian vault support with structured metadata tags, implements automated PR linting/formatting checks, and enhances documentation across 150+ interview guide files across 35+ company directories.


2. Key Enhancements

🏷️ Obsidian Vault & Structured YAML Metadata Support

  • Added standardized YAML frontmatter to interview Markdown files (company, role, interview round index, and tags).
  • Established a fixed 17-topic vocabulary (kubernetes, docker, terraform, aws, azure, gcp, ci-cd, jenkins, ansible, linux, git, monitoring, sre, networking, security, scripting, databases).
  • Enables the repository to be opened directly as an Obsidian vault (Open folder as vault), allowing tag-tree navigation and complex tag queries (e.g. tag:#topic/kubernetes tag:#topic/terraform).

⚙️ CI/CD & Code Quality Automation

  • New GitHub Action: markdown-lint.yml runs on every pull request to automatically lint changed Markdown files using markdownlint-cli2.
  • Linting Config: Created .markdownlint-cli2.jsonc. Custom rules were configured to ensure auto-fixing preserves question list numbering (MD029, MD030, MD007 disabled), preventing content corruption while enforcing clean formatting (whitespace, blank lines, bare URLs, code block languages).
  • PR Template: Added .github/PULL_REQUEST_TEMPLATE.md with a clear checklist covering contribution type, interview details, YAML frontmatter compliance, placement conventions, and formatting checks.

📖 Documentation & README Improvements

  • Updated README.md with detailed instructions on:
    • Using the repository as an Obsidian vault.
    • File naming & placement rules (<Role>.md, numbered sequences like DevOps_Engineer_2.md).
    • Formatting guidelines & running the local auto-fix command (npx --yes markdownlint-cli2@0.23.2 --fix "**/*.md").
    • Submitting pull requests using the template.

📝 Interview Markdown Standardizations (35+ Directories)

  • Formatted code blocks with language identifiers (e.g. bash, yaml, text).
  • Cleaned up stray trailing whitespaces, unformatted inline links, and list block spacing across interview files for companies including:
    • Accenture, Accion Labs, Accolite, Akamai, AMEX, Amazon, Capgemini, Cisco, Commonwealth Bank, Deloitte, EPAM, EY, F5, HCL, IBM, Infosys, JPMorgan, LTIMindtree, Oracle, TCS, Verizon, Wipro, ZS Associates, Others, and more.

3. Directory-by-Directory Commit Breakdown

Target Directory / File Summary of Changes
.github/ Added PR template & GitHub Action workflow for PR markdown linting
.markdownlint-cli2.jsonc Created markdownlint configuration tailored for ordered Q&A lists
README.md Added Obsidian vault guide, tag schema, and contribution/formatting steps
Accenture/ Metadata tag fixes and formatting updates in Accenture guides
Accion_Labs/ Formatting and topic tag alignment for SRE interview guide
Altimetrik/ Code fence formatting & list layout fixes
Amazon/ Standardized YAML frontmatter and formatting for DevOps Consultant roles
CGI/ Question listing & YAML header updates
CTS/ Updated 3 DevOps Engineer round files with topic tags
Capgemini/ Standardized formatting for Capgemini DevOps Engineer 1, 2, & 3
Deloitte/ Updated 4 Deloitte interview files with standard tags & code blocks
EPAM/ Standardized 3 EPAM DevOps Engineer interview files
EY/ Added tags and cleaned up formatting in EY interview entries
HCL/ Updated 4 HCL interview guides with proper frontmatter
IBM/ Updated Cloud Engineer and DevOps Engineer 1, 2, 3 files
Infosys/ Standardized Infosys DevOps Engineer & SRE interview guides
JPMorgan/ Updated JPMorgan DevOps & SRE interview files
LTIMindtree/ Standardized 5 LTIMindtree interview entries
Others/ Standardized 20 unnamed interview entries under Others/ (company: "Unknown")
TCS/ Updated TCS DevOps Engineer & SRE files
Wipro/ Standardized 5 Wipro DevOps Engineer files
(Other Companies) Standardized frontmatter, code blocks, and markdown rules across remaining directories

@mchittineni

Copy link
Copy Markdown
Author

@litu54 PR please.

@mchittineni

Copy link
Copy Markdown
Author

Hi @litu54 👋,

I’d appreciate your review of this PR. This is a repository-wide improvement focused on standardisation, maintainability, discoverability, and contribution quality.

Key aspects of this PR

🏷️ Standardised interview guide metadata

  • Added consistent YAML frontmatter across the interview guides.
  • Standardised metadata such as:
    • Company
    • Role
    • Interview round
    • Topic tags
  • Introduced a consistent topic taxonomy covering key DevOps and cloud areas such as Kubernetes, Docker, Terraform, AWS, Azure, GCP, CI/CD, Jenkins, Ansible, Linux, Security, Monitoring, SRE, Networking, and Databases.

📚 Obsidian Vault support

  • The repository can now be used directly as an Obsidian vault.
  • Structured tags make it easier to navigate and search interview questions by technology and topic.
  • This improves the discoverability and usability of the repository for contributors and interview preparation.

⚙️ Markdown quality automation

  • Added automated Markdown linting for pull requests using GitHub Actions.
  • Added a tailored markdownlint-cli2 configuration.
  • The configuration preserves the existing interview question numbering and formatting structure while enforcing consistent Markdown quality.

📝 Contribution process improvements

  • Added a Pull Request template with checks for:
    • Correct file placement
    • Interview metadata
    • YAML frontmatter
    • Formatting requirements
    • Contribution details

📖 Documentation improvements

  • Updated the README with guidance on:
    • Using the repository as an Obsidian vault
    • File naming and placement conventions
    • Metadata and tagging standards
    • Markdown formatting
    • Running linting and auto-fix checks locally
    • Submitting contributions

🔄 Repository-wide standardisation

  • Standardised formatting, YAML metadata, code blocks, whitespace, links, and list formatting across 150+ interview guide files and 35+ company directories.

Key requirement for review

Because this PR touches a large number of documentation files (123 commits), the main areas I would appreciate feedback on are:

  1. Whether the YAML frontmatter structure and topic taxonomy are suitable for the repository long-term.
  2. Whether Obsidian vault support adds value and should become part of the project’s standard workflow.
  3. Whether the Markdown linting rules appropriately balance consistency without modifying interview question numbering or content structure.
  4. Whether the updated contribution guidelines and PR template align with the preferred contribution process.
  5. Any concerns regarding backward compatibility or existing contributor workflows.

The intention is to provide a scalable structure for future interview-guide contributions while keeping the existing content intact and improving consistency and discoverability.

Thank you for taking the time to review this large update. I’m happy to address any feedback or split specific parts into follow-up PRs if that would make the review easier.

@mchittineni
mchittineni deleted the feature/update-interview-guides branch August 27, 2026 10:23
@mchittineni
mchittineni restored the feature/update-interview-guides branch August 27, 2026 10:29
@mchittineni mchittineni reopened this Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant