Skip to content

Conversation

NickVolynkin
Copy link
Collaborator

@NickVolynkin NickVolynkin commented Jul 23, 2025

  • split virtual routers and mikrotik to Networking section

Summary by CodeRabbit

  • New Features

    • Added new documentation sections for networking, virtualization, and managed applications, including new reference files and improved structure.
    • Introduced Makefile and scripts to automate documentation updates for managed applications.
  • Documentation

    • Reorganized and unified documentation structure for managed applications, networking, and virtualization.
    • Updated and standardized front matter metadata, including titles, descriptions, weights, and aliases for improved navigation and SEO.
    • Updated internal and external documentation links for clarity and consistency.
    • Added and updated reference pages for managed services and infrastructure components.
  • Chores

    • Simplified and consolidated workflow automation for updating managed application docs.
    • Updated ignore rules and configuration files for improved documentation management.
    • Removed obsolete and redundant documentation and scripts.

Copy link
Contributor

coderabbitai bot commented Jul 23, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This update restructures and enhances documentation for managed applications, networking, and virtualization in Cozystack. It introduces new and reorganized markdown files, updates metadata and internal references, consolidates automation scripts into a Makefile, and replaces old scripts with improved versions. Documentation navigation, aliasing, and content grouping are streamlined, and build automation is simplified.

Changes

Files/Paths Change Summary
.github/workflows/update-managed-apps.yaml, Makefile, hack/fill_templates.sh, hack/update_apps.sh Workflow now uses make update-all to replace multiple script invocations; new Makefile orchestrates documentation updates and templating; new scripts for templating and updating markdown files added, replacing older versions.
.gitignore Removed rule to ignore markdown files in any _include directory.
hugo.yaml Generalized excludeFiles pattern for _include directories in Hugo module mounts.
content/en/docs/reference/applications/_include/fill_templates.sh,
.../update_apps.sh
Deleted old Bash scripts for generating and updating application markdown files.
content/en/docs/reference/_index.md,
.../applications/_index.md
Deleted reference documentation index files.
content/en/docs/operations/virtualization/_index.md Deleted old virtualization section index file.
content/en/docs/applications/_index.md Major restructuring: reorganized sections, updated metadata, unified managed application presentation, and updated internal references.
content/en/docs/applications/_include/*.md
(clickhouse, ferretdb, kafka, mysql, nats, postgres, rabbitmq, redis, tenant)
Added new markdown files with front matter for various managed applications.
content/en/docs/applications/*.md
(clickhouse, ferretdb, kafka, mysql, nats, postgres, rabbitmq, redis, tenant)
Updated front matter: added/adjusted weight, aliases, and other metadata fields.
content/en/docs/kubernetes/_include/_index.md,
.../kubernetes/_index.md
Added new Kubernetes section index; updated metadata and aliases for managed Kubernetes documentation.
content/en/docs/kubernetes/backup-and-recovery.md Updated front matter: new title, link title, and aliases.
content/en/docs/networking/_index.md,
.../http-cache.md,
.../tcp-balancer.md,
.../vpn.md
Added new networking documentation index and service files with descriptive metadata and aliases.
content/en/docs/networking/http-cache.md,
.../tcp-balancer.md,
.../virtual-router.md,
.../vpn.md,
.../mikrotik.md
Enhanced front matter: added/updated descriptions, weights, and aliases for networking docs.
content/en/docs/virtualization/_index.md,
.../virtual-machine.md,
.../vm-disk.md,
.../vm-instance.md,
.../gpu.md,
.../resources.md,
.../windows.md
Updated metadata, weights, aliases, and internal references for virtualization docs; added new include files for VM components.
content/en/docs/guides/bundles/_index.md,
.../concepts.md,
.../platform-stack/_index.md,
.../tenants/_index.md,
.../introduction/_index.md
Updated and reorganized documentation links and references for managed applications, virtualization, and networking.
content/en/docs/cozystack-api.md Increased document weight in metadata.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow
    participant Makefile
    participant fill_templates.sh
    participant update_apps.sh
    participant GitHubRepo

    Workflow->>Makefile: make update-all
    Makefile->>fill_templates.sh: Generate templates for all app groups
    fill_templates.sh->>GitHubRepo: Fetch README titles for apps
    Makefile->>update_apps.sh: Update docs for all app groups
    update_apps.sh->>GitHubRepo: Fetch README content for apps
    update_apps.sh->>Docs: Write/append updated markdown files
    Makefile->>Workflow: Done (git status -s)
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇
In burrows deep, I tidy docs anew,
With scripts and Make, I streamline what you do.
Metadata shines, aliases align,
Networking, VMs, and apps all in line.
Hop, skip, and jump—your docs now gleam,
Thanks to a bunny’s organized dream!
🥕

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7f6b6b and 8e12d10.

📒 Files selected for processing (53)
  • .gitignore (0 hunks)
  • Makefile (1 hunks)
  • content/en/docs/_index.md (1 hunks)
  • content/en/docs/applications/_include/clickhouse.md (1 hunks)
  • content/en/docs/applications/_include/ferretdb.md (1 hunks)
  • content/en/docs/applications/_include/kafka.md (1 hunks)
  • content/en/docs/applications/_include/mysql.md (1 hunks)
  • content/en/docs/applications/_include/nats.md (1 hunks)
  • content/en/docs/applications/_include/postgres.md (1 hunks)
  • content/en/docs/applications/_include/rabbitmq.md (1 hunks)
  • content/en/docs/applications/_include/redis.md (1 hunks)
  • content/en/docs/applications/_include/tenant.md (1 hunks)
  • content/en/docs/applications/_index.md (5 hunks)
  • content/en/docs/applications/clickhouse.md (1 hunks)
  • content/en/docs/applications/ferretdb.md (1 hunks)
  • content/en/docs/applications/kafka.md (1 hunks)
  • content/en/docs/applications/mysql.md (1 hunks)
  • content/en/docs/applications/nats.md (1 hunks)
  • content/en/docs/applications/postgres.md (1 hunks)
  • content/en/docs/applications/rabbitmq.md (1 hunks)
  • content/en/docs/applications/redis.md (1 hunks)
  • content/en/docs/applications/tenant.md (1 hunks)
  • content/en/docs/cozystack-api.md (1 hunks)
  • content/en/docs/guides/bundles/_index.md (2 hunks)
  • content/en/docs/guides/concepts.md (2 hunks)
  • content/en/docs/guides/platform-stack/_index.md (2 hunks)
  • content/en/docs/guides/tenants/_index.md (3 hunks)
  • content/en/docs/introduction/_index.md (2 hunks)
  • content/en/docs/kubernetes/_include/_index.md (1 hunks)
  • content/en/docs/kubernetes/_index.md (1 hunks)
  • content/en/docs/kubernetes/backup-and-recovery.md (1 hunks)
  • content/en/docs/networking/_include/http-cache.md (1 hunks)
  • content/en/docs/networking/_include/tcp-balancer.md (1 hunks)
  • content/en/docs/networking/_include/vpn.md (1 hunks)
  • content/en/docs/networking/_index.md (1 hunks)
  • content/en/docs/networking/http-cache.md (1 hunks)
  • content/en/docs/networking/mikrotik.md (1 hunks)
  • content/en/docs/networking/tcp-balancer.md (1 hunks)
  • content/en/docs/networking/virtual-router.md (1 hunks)
  • content/en/docs/networking/vpn.md (1 hunks)
  • content/en/docs/reference/_index.md (0 hunks)
  • content/en/docs/reference/applications/_index.md (0 hunks)
  • content/en/docs/virtualization/_include/virtual-machine.md (1 hunks)
  • content/en/docs/virtualization/_include/vm-disk.md (1 hunks)
  • content/en/docs/virtualization/_include/vm-instance.md (1 hunks)
  • content/en/docs/virtualization/_index.md (4 hunks)
  • content/en/docs/virtualization/resources.md (1 hunks)
  • content/en/docs/virtualization/virtual-machine.md (1 hunks)
  • content/en/docs/virtualization/vm-disk.md (1 hunks)
  • content/en/docs/virtualization/vm-instance.md (1 hunks)
  • content/en/docs/virtualization/windows.md (1 hunks)
  • hack/update_apps.sh (1 hunks)
  • hugo.yaml (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch virtualization-first-level

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@NickVolynkin NickVolynkin self-assigned this Jul 23, 2025
Copy link

netlify bot commented Jul 23, 2025

Deploy Preview for cozystack ready!

Name Link
🔨 Latest commit 8e12d10
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/68838709ff8a430008ac530a
😎 Deploy Preview https://deploy-preview-266--cozystack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @NickVolynkin, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on improving the organization and discoverability of documentation by restructuring the docs directory. It elevates virtualization-related content to a more prominent top-level section and creates a new, dedicated section for networking-specific guides, ensuring a clearer logical separation of topics. The changes also include necessary link updates and the addition of aliases to maintain link integrity.

Highlights

  • Documentation Structure Reorganization: The primary change is a significant restructuring of the documentation, moving core virtualization-related guides from /docs/operations/virtualization to a more prominent top-level /docs/virtualization path.
  • New Networking Section: A dedicated /docs/networking section has been introduced to house networking-specific guides, specifically virtual-router.md and mikrotik.md, which were previously under the operations/virtualization path.
  • Path Updates and Aliases: All internal links pointing to the old virtualization paths have been updated to reflect the new structure. Additionally, aliases have been added to the front matter of all moved/renamed files to ensure backward compatibility and prevent broken links for existing references.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors the documentation by moving virtualization guides to a top-level section and creating a new networking section. The changes are a good improvement to the structure. I've provided a few suggestions to improve navigation clarity, fix link targets, and correct a minor typo. Addressing these will enhance the overall quality and user experience of the documentation.

@NickVolynkin NickVolynkin changed the title [docs] Move virtualization guids to the first level [docs] Move virtualization guides to the first level Jul 23, 2025
@NickVolynkin NickVolynkin force-pushed the virtualization-first-level branch 6 times, most recently from 7c7c008 to ec753ef Compare July 25, 2025 13:14
@NickVolynkin NickVolynkin marked this pull request as ready for review July 25, 2025 13:14
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

♻️ Duplicate comments (7)
content/en/docs/applications/nats.md (1)

4-6: Provide an explicit numeric weight

Same issue as in FerretDB page.

-weight: 
+weight: 0
content/en/docs/applications/kafka.md (1)

4-6: Empty weight front-matter

Please set an explicit integer or drop the key.

-weight: 
+# weight: 10   # example
content/en/docs/applications/mysql.md (1)

4-6: Specify weight explicitly

Same remark as for the other application docs.

-weight: 
+weight: 0
content/en/docs/virtualization/resources.md (1)

4-4: Trailing comma still present – YAML will parse but is noisy
This was flagged earlier; keeping the comma serves no purpose and can confuse future diffs.

-description: "Reference for VM Instance Types and Instance Profiles,"
+description: "Reference for VM Instance Types and Instance Profiles"
content/en/docs/networking/_index.md (1)

1-8: Add a trailing newline to satisfy POSIX tools

The file lacks a terminating newline. Some linters and diff viewers complain about this.

-This documentation section explains network configuration, virtual routers, load balancers, and other networking capabilities in Cozystack.
+This documentation section explains network configuration, virtual routers, load balancers, and other networking capabilities in Cozystack.
+
content/en/docs/virtualization/_index.md (1)

2-4: linkTitle duplicates the page below – rename to avoid sidebar confusion

This was raised in a previous review but is still unresolved. Keeping two items with identical “Virtual Machines” labels (the section index and virtual-machines.md) confuses users.

-title: "Virtual Machines in Cozystack"
-linkTitle: "Virtual Machines"
+title: "Virtualization in Cozystack"
+linkTitle: "Virtualization"
content/en/docs/guides/bundles/_index.md (1)

38-40: Same broken landing page as flagged earlier
The reference [vm] still points to /docs/virtualization, which is empty.
See previous review — please update to /docs/virtualization/virtual-machines for a meaningful target.

🧹 Nitpick comments (36)
content/en/docs/_index.md (1)

11-12: Confirm alias path format & add trailing-slash variant

Hugo treats “pretty URLs” as directory paths ending with a /. An alias without the trailing slash (/docs/reference) will generate a redirect HTML file at /docs/reference/index.html, but incoming links that include the trailing slash (/docs/reference/) will not be redirected unless a second alias is declared.

Consider adding the slash-terminated variant to avoid 404s and preserve existing inbound links:

 aliases:
   - /docs/reference
+  - /docs/reference/
content/en/docs/applications/mysql.md (3)

25-26: Typo in placeholder – <instnace>

-kubectl edit mariadb <instnace>
+kubectl edit mariadb <instance>

61-64: Multiple typos in “Known issues” list

  • “can't not be finished” → “cannot be finished”
  • “finised” → “finished”
  • “inmplemented” → “implemented”

Please correct for professionalism and clarity.


66-72: Misspelling of “indices”

-**Corrupted indicies**
+**Corrupted indices**
content/en/docs/applications/rabbitmq.md (1)

4-6: Confirm weight/null handling & keep metadata explicit

weight: is currently set to YAML null (empty).
In Hugo this evaluates to 0, which may unexpectedly pin the page to the top of its section.
If the intent is to defer ordering to section defaults, consider omitting the key altogether; otherwise give it an explicit integer.

-weight: 
+# weight: 30      # ← example value

Same for any other newly-added application docs for consistency.

content/en/docs/applications/postgres.md (1)

4-6: Unclear ordering – provide concrete weight or drop the key

Leaving weight: empty serialises as null → 0.
Give an explicit value or remove the key so Hugo falls back to alphabetic sorting.

-weight: 
+# weight: 40

(Replicate across other app pages if needed.)

content/en/docs/networking/mikrotik.md (1)

5-7: Alias looks good; use trailing slash only if old site had it

The new alias /docs/operations/virtualization/mikrotik will 301 old links.
If legacy URLs ever ended with a trailing slash, add a second alias to cover it:

   - /docs/operations/virtualization/mikrotik
+  - /docs/operations/virtualization/mikrotik/

Minor but prevents a 404 for bookmarked paths.

content/en/docs/applications/clickhouse.md (1)

4-7: Fill in empty description & weight for better SEO / ordering

An empty description diminishes search-engine snippets and on-site previews; add a concise summary (≤ 160 chars).
Also decide on a concrete weight or omit the field as noted in earlier comments.

-description: ""
-weight: 
+description: "High-performance column-oriented OLAP DBMS with managed backups, sharding and scaling."
+# weight: 35
content/en/docs/applications/_include/kafka.md (1)

1-7: Provide a concrete weight or drop the field

weight: is left blank. Hugo treats an empty value as null, which is valid YAML but may lead to non-deterministic ordering in section menus. Either supply a numeric value or remove the key to rely on default ordering.

-weight: 
+# weight: 50            # ← example; adjust to desired position
content/en/docs/applications/redis.md (1)

4-6: Set weight or omit it for consistency

An empty weight: behaves the same as omitting the key but adds noise. Recommend either giving it a concrete number (to control menu order) or deleting the field.

-weight: 
+# weight: 50   # or remove the line entirely
content/en/docs/applications/tenant.md (2)

4-6: Front-matter: avoid weight: without a value

weight: is declared but left empty.
In Hugo this is parsed as null, which:

  1. Breaks numeric sorting in menu sections (pages with explicit numbers are grouped first, null sinks to the bottom unpredictably).
  2. Yields noisy warnings in strict front-matter linters.

Either assign an explicit integer or drop the key:

-weight: 
+weight: 20            # <- pick an ordering number

If you really want the default ordering, delete the key entirely.


2-3: Consider adding a short description: for SEO & search

Most new docs in this PR include a description: field; this one does not.
Adding one keeps front-matter consistent and improves search snippets.

content/en/docs/applications/_include/tenant.md (1)

4-6: Blank weight: value – same issue as main Tenant doc

Leaving weight: empty sets it to null. Use an explicit integer or remove the key to avoid menu-ordering quirks.

-weight: 
+weight: 20   # or delete this line
content/en/docs/applications/_include/nats.md (1)

4-6: Blank weight: – set or drop

Same rationale as previous comments; specify an integer weight or omit the key to keep section ordering deterministic.

-weight: 
+weight: 30   # example
content/en/docs/networking/vpn.md (1)

4-4: Minor duplication in description

The first sentence of the body repeats the exact wording of the description: line.
You might trim one or rephrase to avoid redundancy in search previews.

content/en/docs/applications/_include/rabbitmq.md (1)

4-9: Empty weight and body may lead to an orphaned/blank page

Leaving weight: empty and providing no body means:

  1. Hugo will treat the weight as 0, pushing the item to the very top unless overridden elsewhere.
  2. The /docs/reference/applications/rabbitmq alias will render a page consisting only of front-matter if the template scripts are not run beforehand.

If the file is always post-processed by hack/update_apps.sh, ignore this. Otherwise, consider either removing weight or giving it an explicit value plus a one-line summary to avoid a blank page.

 weight: 
+summary: "RabbitMQ as a fully-managed Cozystack application."
content/en/docs/applications/_include/postgres.md (1)

4-7: Add a postgresql alias for consistency & SEO

The human-readable name is PostgreSQL, yet the alias uses /postgres.
Add the long form too so old links and search results resolve correctly.

 aliases:
   - /docs/reference/applications/postgres
+  - /docs/reference/applications/postgresql
content/en/docs/networking/http-cache.md (1)

3-7: Alias path may confuse category routing

The page lives under Networking, but the alias points to /reference/applications/http-cache.
Consider also adding a networking-scoped alias for clarity and backlink continuity.

 aliases:
   - /docs/reference/applications/http-cache
+  - /docs/networking/http-cache
content/en/docs/applications/_include/mysql.md (1)

2-6: Weight left empty – define a value or remove the key altogether

weight: is present but has no value. Hugo treats an empty weight as zero, which unintentionally hoists the page to the top of its section.
Either supply an explicit number (keeps ordering predictable) or drop the key.

-weight: 
+# weight: 25        # ← pick an ordering number
content/en/docs/networking/_include/tcp-balancer.md (1)

4-7: Alias path may be misleading – confirm section prefix

The alias points to /docs/reference/applications/tcp-balancer while the file lives under networking.
If the intent is to maintain a legacy URL that lived in “applications”, add a second alias for the new canonical path to avoid 404s.

 aliases:
   - /docs/reference/applications/tcp-balancer
+  - /docs/reference/networking/tcp-balancer   # new canonical location
content/en/docs/virtualization/_include/virtual-machine.md (1)

4-6: Section / alias mismatch – double-check pathing

The alias again references /applications/virtual-machine, yet the document is in the virtualization tree.
Verify that this is intentional (e.g., preserving an old route) and, if not, update accordingly.

-  - /docs/reference/applications/virtual-machine
+  - /docs/reference/virtualization/virtual-machine
content/en/docs/applications/_include/clickhouse.md (1)

4-5: Missing description and weight – fill for consistency & SEO

Other _include files often provide meaningful description text and a numeric weight.
Populate these to keep the autogenerated navigation consistent.

-description: ""
-weight: 
+description: "Managed ClickHouse Service offers a fully-hosted analytics database with zero-ops."
+# weight: 20
content/en/docs/virtualization/virtual-machine.md (1)

4-6: Alias duplicates _include file – OK but ensure no circular canonical link

Adding the same alias here and in _include/virtual-machine.md is harmless, but make sure only one of the two pages is published; otherwise Hugo can emit duplicate URL conflicts.

If _include is merely a shortcode include, everything is fine. If both compile to standalone pages, consider removing the alias from one to avoid clashes.

content/en/docs/kubernetes/_include/_index.md (1)

6-7: Add a trailing slash to the alias to avoid duplicate-URL issues

Hugo treats paths with/without a trailing slash as distinct. Most of the existing docs use the “folder-style” URL (/path/). Appending the trailing slash keeps the alias consistent and prevents accidental 404s or duplicate content penalties.

-  - /docs/reference/applications/kubernetes
+  - /docs/reference/applications/kubernetes/
content/en/docs/virtualization/_include/vm-disk.md (1)

6-6: Align alias with new section location (optional)

If the old path is solely for backward compatibility, consider adding a second alias that reflects the new top-level location (/docs/virtualization/vm-disk/) so both old and new links resolve.

   - /docs/reference/applications/vm-disk
+  - /docs/virtualization/vm-disk/
content/en/docs/virtualization/_include/vm-instance.md (1)

2-7: Alias slug does not match page slug

The file is named vm-instance.md, but the alias is vm-instance while the public title is simply “Virtual Machine”.
For consistency (SEO and user expectations), either:

  1. Rename the alias to match the public slug you intend (e.g., /docs/virtualization/virtual-machine/), or
  2. Rename the file to virtual-machine.md.

Leaving the mismatch may confuse users and hamper canonical-URL logic.

content/en/docs/networking/_include/http-cache.md (1)

6-7: Consider dual aliases for old and new paths

To ensure legacy links keep working after the doc re-org, you can keep the existing alias and add one for the new networking location:

   - /docs/reference/applications/http-cache
+  - /docs/networking/http-cache/
content/en/docs/networking/_include/vpn.md (1)

4-4: Minor grammar tweak for the description

Current wording misses an article and should pluralise “VPN server”.

-description: "Managed VPN Service simplifies the deployment and management of VPN server, enabling you to establish secure connections with ease."
+description: "Managed VPN Service simplifies the deployment and management of VPN servers, enabling you to establish secure connections with ease."
content/en/docs/guides/platform-stack/_index.md (1)

136-138: Point “Virtual machines” to a populated page instead of the empty section index

/docs/virtualization currently contains only front-matter, so users land on an empty page.
Switch the link to the virtual-machines overview to keep the experience consistent with the earlier Mikrotik/Router guides update.

- -   [Virtual machines]({{% ref "/docs/virtualization" %}}), supporting Linux and Windows OS.
+ -   [Virtual machines]({{% ref "/docs/virtualization/virtual-machines" %}}), supporting Linux and Windows OS.
Makefile (2)

1-12: Add a conventional default all target

Many CI systems & local workflows expect make (with no args) to succeed.
Expose all: that depends on update-all (or another sensible default) to improve ergonomics and satisfy static-analysis warnings.

 .PHONY: all update-apps update-vms update-networking update-k8s update-all \
-        template-apps template-vms template-networking template-k8s template-all
+        template-apps template-vms template-networking template-k8s template-all

+all: update-all

12-46: Consider adding a clean target to purge generated files

Static analysis flagged the absence of clean. Having a simple

clean:
	@rm -rf $(APPS_DEST_DIR)/_include \
	         $(VMS_DEST_DIR)/_include \
	         $(NETWORKING_DEST_DIR)/_include \
	         $(K8S_DEST_DIR)/_include

helps local contributors reset stale artefacts.

hack/fill_templates.sh (2)

71-76: Fetch only the first bytes instead of the full README for efficiency

curl -fsSL downloads the whole file even though only the first line is needed.
A --range 0-1023 (or similar) header saves bandwidth and speeds up CI.

-  if ! first_line=$(curl -fsSL "$readme_url" | head -n 1); then
+  if ! first_line=$(curl -fsSL --range 0-1023 "$readme_url" | head -n 1); then

83-86: Edge-case: linkTitle may become empty after stripping words

If the README title is exactly “Managed Service”, link_title ends up blank, producing ugly navigation.
Safeguard with a fallback:

- link_title=$(echo "$title" | sed -E 's/\b(Managed|Service)\b//Ig' | xargs)
+ link_title=$(echo "$title" | sed -E 's/\b(Managed|Service)\b//Ig' | xargs)
+ [[ -z "$link_title" ]] && link_title="$title"
hack/update_apps.sh (1)

65-67: SRC_DIR is calculated but never used

The static-analysis warning is correct: SRC_DIR is dead code after refactors.
Drop it to reduce cognitive noise.

-# Derive templates location: DEST_DIR/_include
-SRC_DIR="${DEST_DIR%/}/_include"
content/en/docs/applications/_index.md (2)

55-59: Brand name casing – use “ClickHouse” consistently

Line 58 links to [Clickhouse], but the official spelling is “ClickHouse”.
Consistent casing improves searchability and avoids brand nitpicks.

--   Managed application reference: [Clickhouse]({{% ref "/docs/applications/clickhouse" %}})
+-   Managed application reference: [ClickHouse]({{% ref "/docs/applications/clickhouse" %}})

183-185: Replace bare URL with a proper Markdown link

markdownlint flags the naked URL; wrapping it keeps the document lint-clean and improves readability.

--   Docs: https://www.haproxy.com/documentation/
+-   Docs: [HAProxy documentation](https://www.haproxy.com/documentation/)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b909d33 and ec753ef.

📒 Files selected for processing (59)
  • .github/workflows/update-managed-apps.yaml (1 hunks)
  • .gitignore (0 hunks)
  • Makefile (1 hunks)
  • content/en/docs/_index.md (1 hunks)
  • content/en/docs/applications/_include/clickhouse.md (1 hunks)
  • content/en/docs/applications/_include/ferretdb.md (1 hunks)
  • content/en/docs/applications/_include/kafka.md (1 hunks)
  • content/en/docs/applications/_include/mysql.md (1 hunks)
  • content/en/docs/applications/_include/nats.md (1 hunks)
  • content/en/docs/applications/_include/postgres.md (1 hunks)
  • content/en/docs/applications/_include/rabbitmq.md (1 hunks)
  • content/en/docs/applications/_include/redis.md (1 hunks)
  • content/en/docs/applications/_include/tenant.md (1 hunks)
  • content/en/docs/applications/_index.md (5 hunks)
  • content/en/docs/applications/clickhouse.md (1 hunks)
  • content/en/docs/applications/ferretdb.md (1 hunks)
  • content/en/docs/applications/kafka.md (1 hunks)
  • content/en/docs/applications/mysql.md (1 hunks)
  • content/en/docs/applications/nats.md (1 hunks)
  • content/en/docs/applications/postgres.md (1 hunks)
  • content/en/docs/applications/rabbitmq.md (1 hunks)
  • content/en/docs/applications/redis.md (1 hunks)
  • content/en/docs/applications/tenant.md (1 hunks)
  • content/en/docs/cozystack-api.md (1 hunks)
  • content/en/docs/guides/bundles/_index.md (2 hunks)
  • content/en/docs/guides/concepts.md (2 hunks)
  • content/en/docs/guides/platform-stack/_index.md (2 hunks)
  • content/en/docs/guides/tenants/_index.md (3 hunks)
  • content/en/docs/introduction/_index.md (2 hunks)
  • content/en/docs/kubernetes/_include/_index.md (1 hunks)
  • content/en/docs/kubernetes/_index.md (1 hunks)
  • content/en/docs/kubernetes/backup-and-recovery.md (1 hunks)
  • content/en/docs/networking/_include/http-cache.md (1 hunks)
  • content/en/docs/networking/_include/tcp-balancer.md (1 hunks)
  • content/en/docs/networking/_include/vpn.md (1 hunks)
  • content/en/docs/networking/_index.md (1 hunks)
  • content/en/docs/networking/http-cache.md (1 hunks)
  • content/en/docs/networking/mikrotik.md (1 hunks)
  • content/en/docs/networking/tcp-balancer.md (1 hunks)
  • content/en/docs/networking/virtual-router.md (1 hunks)
  • content/en/docs/networking/vpn.md (1 hunks)
  • content/en/docs/operations/virtualization/_index.md (0 hunks)
  • content/en/docs/reference/_index.md (0 hunks)
  • content/en/docs/reference/applications/_include/fill_templates.sh (0 hunks)
  • content/en/docs/reference/applications/_include/update_apps.sh (0 hunks)
  • content/en/docs/reference/applications/_index.md (0 hunks)
  • content/en/docs/virtualization/_include/virtual-machine.md (1 hunks)
  • content/en/docs/virtualization/_include/vm-disk.md (1 hunks)
  • content/en/docs/virtualization/_include/vm-instance.md (1 hunks)
  • content/en/docs/virtualization/_index.md (4 hunks)
  • content/en/docs/virtualization/gpu.md (1 hunks)
  • content/en/docs/virtualization/resources.md (1 hunks)
  • content/en/docs/virtualization/virtual-machine.md (1 hunks)
  • content/en/docs/virtualization/vm-disk.md (1 hunks)
  • content/en/docs/virtualization/vm-instance.md (1 hunks)
  • content/en/docs/virtualization/windows.md (1 hunks)
  • hack/fill_templates.sh (1 hunks)
  • hack/update_apps.sh (1 hunks)
  • hugo.yaml (1 hunks)
💤 Files with no reviewable changes (6)
  • .gitignore
  • content/en/docs/reference/_index.md
  • content/en/docs/operations/virtualization/_index.md
  • content/en/docs/reference/applications/_index.md
  • content/en/docs/reference/applications/_include/fill_templates.sh
  • content/en/docs/reference/applications/_include/update_apps.sh
🧰 Additional context used
🧬 Code Graph Analysis (2)
hack/update_apps.sh (1)
hack/fill_templates.sh (1)
  • usage (4-22)
hack/fill_templates.sh (1)
hack/update_apps.sh (1)
  • usage (4-23)
🪛 markdownlint-cli2 (0.17.2)
content/en/docs/guides/bundles/_index.md

23-23: Reference links and images should use a label that is defined
Missing link or image reference definition: "k8s"

(MD052, reference-links-images)


24-24: Reference links and images should use a label that is defined
Missing link or image reference definition: "apps"

(MD052, reference-links-images)


25-25: Reference links and images should use a label that is defined
Missing link or image reference definition: "vm"

(MD052, reference-links-images)


27-27: Reference links and images should use a label that is defined
Missing link or image reference definition: "api"

(MD052, reference-links-images)

content/en/docs/applications/_index.md

184-184: Bare URL used

(MD034, no-bare-urls)

🪛 checkmake (0.2.2)
Makefile

[warning] 12-12: Missing required phony target "all"

(minphony)


[warning] 12-12: Missing required phony target "clean"

(minphony)


[warning] 12-12: Missing required phony target "test"

(minphony)

🪛 Shellcheck (0.10.0)
hack/update_apps.sh

[warning] 66-66: SRC_DIR appears unused. Verify use (or export if used externally).

(SC2034)

🔇 Additional comments (21)
content/en/docs/virtualization/gpu.md (1)

6-7: Alias addition looks correct and valuable

Backward-compatibility URL is preserved, nothing else to flag here.

content/en/docs/cozystack-api.md (1)

4-4: Bumped weight to 70 – verify sidebar order

Raising the weight from 50 → 70 pushes this page further down the section.
Double-check this aligns with the desired navigation flow after the virtualization-guide shuffle.

content/en/docs/virtualization/vm-instance.md (1)

4-6: Metadata addition looks good

weight and aliases are syntactically correct YAML and fit the new docs hierarchy.
No action required.

content/en/docs/virtualization/vm-disk.md (1)

4-6: Metadata addition looks good

The new weight and aliases fields follow the established pattern.
No further change needed.

content/en/docs/networking/vpn.md (1)

4-7: Alias path may be misleading

The alias points to /docs/reference/applications/vpn, while the page now lives under Networking.
If the old path was /docs/reference/networking/vpn (rather than applications), users following the previous link will 404.

Please confirm the historical URL and adjust if needed:

-  - /docs/reference/applications/vpn
+  - /docs/reference/networking/vpn   # if this was the actual old route
content/en/docs/virtualization/windows.md (1)

6-7: Weight 50: confirm section ordering

Most sibling pages have weights ≤ 20 (per previous commits). A jump to 50 pushes this page far down the menu.
Double-check the intended order; adjust if accidental.

content/en/docs/applications/_include/redis.md (1)

4-7: Looks good – consistent with other include files

No issues spotted.

content/en/docs/networking/virtual-router.md (1)

5-7: Confirm the intent of raising weight → 40

In Hugo, higher weight pushes the page lower in the left-hand menu.
If the goal was to make Virtual Routers more prominent after the docs reshuffle, the weight should be reduced (e.g., 10), not increased. Please verify.

.github/workflows/update-managed-apps.yaml (1)

28-31: Confirm make (and the new Makefile) is available in the runner image

The workflow now relies on GNU Make (make update-all).
ubuntu-latest images ship with GNU Make, but if the repository is ever executed on another runner image or a slimmed-down container, this step will fail silently and abort the whole sync job.

Consider adding an explicit check (e.g. command -v make) or installing make in the step to avoid brittle CI behaviour.
Alternatively, pin the runner image in runs-on: to one you know contains Make.

content/en/docs/networking/tcp-balancer.md (1)

4-7: Front-matter enrichment looks good

Adding description, weight, and the legacy aliases keeps existing URLs working and improves menu ordering—no objections.

content/en/docs/guides/concepts.md (1)

51-51: Hugo ref shortcode path may be incorrect

{{% ref "docs/kubernetes" %}} is a section path, not a full page.
If the underlying file is content/en/docs/kubernetes/_index.md this is fine, otherwise Hugo will fail with “ref not found”.

Please double-check the target exists; adjust to {{% ref "docs/kubernetes/_index.md" %}} (or the concrete page) if necessary.

hugo.yaml (1)

58-60: Broader _include exclusion is sensible, but validate published pages

Expanding the glob to **/_include/* will also exclude newly introduced include fragments under content/en/docs/networking/_include/ and others, which seems intentional.
Just verify that no stand-alone pages (those expected to be published) accidentally live inside an _include directory, or they will vanish from the site.

content/en/docs/introduction/_index.md (2)

59-66: Link updates LGTM

The updated references are consistent with the new docs hierarchy.


17-19: ✔ New top-level “applications” and “virtualization” sections confirmed
Both content/en/docs/applications/_index.md and content/en/docs/virtualization/_index.md exist with the following titles:

  • Managed Applications: Guides and Reference
  • Virtual Machines in Cozystack

These links (/docs/applications and /docs/virtualization) will resolve correctly.

content/en/docs/kubernetes/backup-and-recovery.md (1)

2-8: Front-matter looks correct; alias preserves the old URL

The rename and added alias should avoid breaking existing inbound links.

content/en/docs/guides/tenants/_index.md (3)

38-39: “Tenant Kubernetes” link update makes sense

No issues noticed, link points to the consolidated Kubernetes docs.


77-77: Anchor might have changed

Verify that the #parameters heading is still present in the new tenant app reference; otherwise this fragment will scroll to nowhere.


13-15: Tenant application reference path is correctly configured

The file content/en/docs/applications/tenant.md exists as a leaf bundle with the slug “tenant” (derived from its filename) and default front-matter, so {% ref "/docs/applications/tenant" %} will resolve without requiring additional aliases.

content/en/docs/guides/platform-stack/_index.md (1)

120-120: Confirm the target of the TCP-balancer link

/docs/networking/tcp-balancer is a newly-created path; double-check that the page exists (or will be added in this PR) to avoid a broken navigation link.

content/en/docs/kubernetes/_index.md (1)

2-7: Front-matter looks good

The new title, linkTitle, weight, and alias align with the docs re-structure. No issues spotted.

hack/fill_templates.sh (1)

34-36: Splitter fails when app list contains tabs or consecutive commas

IFS=', ' drops tabs and treats multiple delimiters as one, but consecutive commas (redis,,mysql) leave empty entries that later fetch a 404.
Filter empties:

IFS=', ' read -r -a APPS <<< "$2"
APPS=("${APPS[@]/#/}") # remove empties
APPS=("${APPS[@]:?}")  # error if still empty

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
- update scripts to fetch content to provided locations
- add makefile with commands to update apps, vms, networking
- use makefile in CI

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin NickVolynkin force-pushed the virtualization-first-level branch from ec753ef to f7f6b6b Compare July 25, 2025 13:24
…ding sections

Virtualization: virtual-machine, vm-instance, vm-disk
Networking: tcp-balancer, http-cache, vpn

Templates are now versioned because they contain edited content.

- Templates updated with aliases for redirecting from previous location.
- Also set weight in templates to ensure correct order.
- Added descriptions for pages in the templates.

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
- Make a directory
- Update scripts and Makefile for updating to kubernetes/_index.md
- Move tenant K8s backups to Kubernetes section
- Add alias for redirecting

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Now /docs/applications has entry content

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
All referential docs are located close to other guides on the topic,
usually on the same pages.

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (3)
content/en/docs/guides/bundles/_index.md (1)

38-40: Link still lands on an almost-empty placeholder page
Previous feedback recommended pointing the VM link to the “virtual-machines” overview rather than to the section index that currently has no body.
Consider updating the reference to improve reader experience.

-[vm]: {{% ref "/docs/virtualization" %}}
+[vm]: {{% ref "/docs/virtualization/virtual-machines" %}}
hack/update_apps.sh (2)

33-39: Missing value checks for --branch, --apps, and --dest remain unresolved
The script still blindly consumes $2. A dangling flag silently turns the next option into the value.
See prior diff suggestion; re-adding here for convenience.


72-85: Destination sub-directories are created only implicitly – cp will fail in CI

cp "$src_file" "$dest_file" expects both parent dirs.
Insert mkdir -p "$(dirname "$src_file")" "$(dirname "$dest_file")" before touch/cp.

🧹 Nitpick comments (5)
Makefile (2)

1-12: Add conventional convenience targets (all, clean, test)
Many CI systems and developers expect these three targets to exist. Even no-op stubs satisfy tooling like checkmake and improve discoverability.

-.PHONY: update-apps update-vms update-networking update-k8s update-all \
-        template-apps template-vms template-networking template-k8s template-all
+.PHONY: all clean test \
+        update-apps update-vms update-networking update-k8s update-all \
+        template-apps template-vms template-networking template-k8s template-all
+
+# Default target – run full update & template generation
+all: update-all template-all
+
+# Place-holders (extend later)
+clean:
+	@echo "Nothing to clean yet"
+
+test:
+	@echo "No tests defined for documentation pipeline"

2-5: Minor style nit – align variable columns for readability
K8S, VMS, and NETWORKING lines have uneven spacing compared to the first. Aligning keeps large variable lists easier to scan.

hack/update_apps.sh (1)

65-67: SRC_DIR is computed but never used
Either remove the variable or use it where intended; leaving it unused is a small smell and triggers shellcheck SC2034.

content/en/docs/applications/_index.md (2)

63-64: Hyphenate compound adjectives (“open-source”, “high-performance”)
Consistent technical writing uses hyphens when a compound adjective precedes a noun.

Also applies to: 102-104


170-185: Replace bare URL with markdown link for accessibility & lint compliance

-Docs: https://www.haproxy.com/documentation/
+Docs: [HAProxy documentation](https://www.haproxy.com/documentation/)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ec753ef and f7f6b6b.

📒 Files selected for processing (59)
  • .github/workflows/update-managed-apps.yaml (1 hunks)
  • .gitignore (0 hunks)
  • Makefile (1 hunks)
  • content/en/docs/_index.md (1 hunks)
  • content/en/docs/applications/_include/clickhouse.md (1 hunks)
  • content/en/docs/applications/_include/ferretdb.md (1 hunks)
  • content/en/docs/applications/_include/kafka.md (1 hunks)
  • content/en/docs/applications/_include/mysql.md (1 hunks)
  • content/en/docs/applications/_include/nats.md (1 hunks)
  • content/en/docs/applications/_include/postgres.md (1 hunks)
  • content/en/docs/applications/_include/rabbitmq.md (1 hunks)
  • content/en/docs/applications/_include/redis.md (1 hunks)
  • content/en/docs/applications/_include/tenant.md (1 hunks)
  • content/en/docs/applications/_index.md (5 hunks)
  • content/en/docs/applications/clickhouse.md (1 hunks)
  • content/en/docs/applications/ferretdb.md (1 hunks)
  • content/en/docs/applications/kafka.md (1 hunks)
  • content/en/docs/applications/mysql.md (1 hunks)
  • content/en/docs/applications/nats.md (1 hunks)
  • content/en/docs/applications/postgres.md (1 hunks)
  • content/en/docs/applications/rabbitmq.md (1 hunks)
  • content/en/docs/applications/redis.md (1 hunks)
  • content/en/docs/applications/tenant.md (1 hunks)
  • content/en/docs/cozystack-api.md (1 hunks)
  • content/en/docs/guides/bundles/_index.md (2 hunks)
  • content/en/docs/guides/concepts.md (2 hunks)
  • content/en/docs/guides/platform-stack/_index.md (2 hunks)
  • content/en/docs/guides/tenants/_index.md (3 hunks)
  • content/en/docs/introduction/_index.md (2 hunks)
  • content/en/docs/kubernetes/_include/_index.md (1 hunks)
  • content/en/docs/kubernetes/_index.md (1 hunks)
  • content/en/docs/kubernetes/backup-and-recovery.md (1 hunks)
  • content/en/docs/networking/_include/http-cache.md (1 hunks)
  • content/en/docs/networking/_include/tcp-balancer.md (1 hunks)
  • content/en/docs/networking/_include/vpn.md (1 hunks)
  • content/en/docs/networking/_index.md (1 hunks)
  • content/en/docs/networking/http-cache.md (1 hunks)
  • content/en/docs/networking/mikrotik.md (1 hunks)
  • content/en/docs/networking/tcp-balancer.md (1 hunks)
  • content/en/docs/networking/virtual-router.md (1 hunks)
  • content/en/docs/networking/vpn.md (1 hunks)
  • content/en/docs/operations/virtualization/_index.md (0 hunks)
  • content/en/docs/reference/_index.md (0 hunks)
  • content/en/docs/reference/applications/_include/fill_templates.sh (0 hunks)
  • content/en/docs/reference/applications/_include/update_apps.sh (0 hunks)
  • content/en/docs/reference/applications/_index.md (0 hunks)
  • content/en/docs/virtualization/_include/virtual-machine.md (1 hunks)
  • content/en/docs/virtualization/_include/vm-disk.md (1 hunks)
  • content/en/docs/virtualization/_include/vm-instance.md (1 hunks)
  • content/en/docs/virtualization/_index.md (4 hunks)
  • content/en/docs/virtualization/gpu.md (1 hunks)
  • content/en/docs/virtualization/resources.md (1 hunks)
  • content/en/docs/virtualization/virtual-machine.md (1 hunks)
  • content/en/docs/virtualization/vm-disk.md (1 hunks)
  • content/en/docs/virtualization/vm-instance.md (1 hunks)
  • content/en/docs/virtualization/windows.md (1 hunks)
  • hack/fill_templates.sh (1 hunks)
  • hack/update_apps.sh (1 hunks)
  • hugo.yaml (1 hunks)
💤 Files with no reviewable changes (6)
  • content/en/docs/operations/virtualization/_index.md
  • .gitignore
  • content/en/docs/reference/_index.md
  • content/en/docs/reference/applications/_index.md
  • content/en/docs/reference/applications/_include/update_apps.sh
  • content/en/docs/reference/applications/_include/fill_templates.sh
✅ Files skipped from review due to trivial changes (10)
  • content/en/docs/_index.md
  • content/en/docs/networking/mikrotik.md
  • content/en/docs/virtualization/_include/vm-disk.md
  • content/en/docs/cozystack-api.md
  • content/en/docs/applications/_include/kafka.md
  • content/en/docs/applications/_include/redis.md
  • content/en/docs/guides/platform-stack/_index.md
  • content/en/docs/virtualization/_include/vm-instance.md
  • content/en/docs/guides/concepts.md
  • content/en/docs/kubernetes/backup-and-recovery.md
🚧 Files skipped from review as they are similar to previous changes (39)
  • content/en/docs/applications/kafka.md
  • content/en/docs/applications/ferretdb.md
  • content/en/docs/applications/rabbitmq.md
  • content/en/docs/applications/mysql.md
  • content/en/docs/virtualization/gpu.md
  • content/en/docs/applications/redis.md
  • content/en/docs/applications/_include/tenant.md
  • content/en/docs/applications/nats.md
  • .github/workflows/update-managed-apps.yaml
  • content/en/docs/virtualization/vm-disk.md
  • content/en/docs/networking/_include/vpn.md
  • content/en/docs/networking/_include/tcp-balancer.md
  • content/en/docs/virtualization/_include/virtual-machine.md
  • content/en/docs/applications/_include/mysql.md
  • content/en/docs/applications/_include/rabbitmq.md
  • content/en/docs/networking/virtual-router.md
  • content/en/docs/applications/_include/ferretdb.md
  • content/en/docs/virtualization/virtual-machine.md
  • content/en/docs/applications/clickhouse.md
  • content/en/docs/networking/http-cache.md
  • content/en/docs/networking/vpn.md
  • content/en/docs/applications/tenant.md
  • content/en/docs/virtualization/resources.md
  • content/en/docs/applications/_include/nats.md
  • content/en/docs/applications/_include/clickhouse.md
  • content/en/docs/networking/_include/http-cache.md
  • content/en/docs/applications/postgres.md
  • content/en/docs/applications/_include/postgres.md
  • content/en/docs/networking/tcp-balancer.md
  • content/en/docs/introduction/_index.md
  • content/en/docs/virtualization/_index.md
  • content/en/docs/networking/_index.md
  • hugo.yaml
  • content/en/docs/guides/tenants/_index.md
  • content/en/docs/kubernetes/_include/_index.md
  • content/en/docs/virtualization/windows.md
  • content/en/docs/kubernetes/_index.md
  • content/en/docs/virtualization/vm-instance.md
  • hack/fill_templates.sh
🧰 Additional context used
🧬 Code Graph Analysis (1)
hack/update_apps.sh (1)
hack/fill_templates.sh (1)
  • usage (4-22)
🪛 LanguageTool
content/en/docs/applications/_index.md

[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...se" %}}) ### FerretDB FerretDB is an open source MongoDB alternative. It translates Mong...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~102-~102: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... is an open-source, simple, secure, and high performance messaging system. It provides a data la...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🪛 markdownlint-cli2 (0.17.2)
content/en/docs/applications/_index.md

184-184: Bare URL used

(MD034, no-bare-urls)

content/en/docs/guides/bundles/_index.md

23-23: Reference links and images should use a label that is defined
Missing link or image reference definition: "k8s"

(MD052, reference-links-images)


24-24: Reference links and images should use a label that is defined
Missing link or image reference definition: "apps"

(MD052, reference-links-images)


25-25: Reference links and images should use a label that is defined
Missing link or image reference definition: "vm"

(MD052, reference-links-images)


27-27: Reference links and images should use a label that is defined
Missing link or image reference definition: "api"

(MD052, reference-links-images)

🪛 checkmake (0.2.2)
Makefile

[warning] 12-12: Missing required phony target "all"

(minphony)


[warning] 12-12: Missing required phony target "clean"

(minphony)


[warning] 12-12: Missing required phony target "test"

(minphony)

🪛 Shellcheck (0.10.0)
hack/update_apps.sh

[warning] 66-66: SRC_DIR appears unused. Verify use (or export if used externally).

(SC2034)

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin NickVolynkin force-pushed the virtualization-first-level branch from f7f6b6b to 8e12d10 Compare July 25, 2025 13:30
@NickVolynkin NickVolynkin merged commit 5d78991 into main Jul 25, 2025
5 of 6 checks passed
@NickVolynkin NickVolynkin deleted the virtualization-first-level branch July 25, 2025 13:34
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