Feature ETP-3291: Doc about the new applyTemplate task#608
Merged
RomanMagnoli merged 12 commits intodevelopfrom Mar 30, 2026
Merged
Feature ETP-3291: Doc about the new applyTemplate task#608RomanMagnoli merged 12 commits intodevelopfrom
RomanMagnoli merged 12 commits intodevelopfrom
Conversation
RomanMagnoli
force-pushed
the
feature/ETP-3291
branch
2 times, most recently
from
b161dd8 to
53afce7
Compare
RomanMagnoli
force-pushed
the
feature/ETP-3291
branch
from
a762281 to
ad20322
Compare
…-guides - Remove getting-started/installation.md and interactive-installation.md - Remove install-etendo-development-environment.md (absorbed into new guides) - Remove install-etendo-main-ui.md (migrated to how-to-guides) - Add local-development.md: full local dev setup guide (IntelliJ + Docker) - Add production-server.md: ISO-only server installation guide with Apache step - Add requirements.md: moved from getting-started/ to developer-guide - Add how-to-configure-etendo-main-ui.md: Main UI config and dev setup - Add how-to-use-interactive-setup.md: alternative guided configuration - Update getting-started/overview.md: remove install/requirements buttons, add Live Builds - Update mkdocs.yml: reorder installation nav by priority, add ES translations - Fix internal links after file moves in upgrade and release-notes pages
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Etendo Classic documentation to introduce and document the setup.applyTemplates Gradle task and to reorganize the installation/getting-started documentation structure, updating MkDocs navigation accordingly.
Changes:
- Added new “How to Use Setup Apply Templates” documentation (EN/ES) plus complementary guides (“Interactive Setup”, “Configure Etendo Main UI”).
- Reworked installation docs into new “Local Development” and “Server Installation” guides and introduced a new requirements page under the developer guide.
- Updated
mkdocs.ymlnavigation (including ES i18n nav) and adjusted a few internal links to point to the new locations.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updates nav structure; adds new how-to guides and new installation doc paths; removes old Getting Started installation entries. |
| docs/whats-new/release-notes/etendo-classic/release-notes.md | Updates requirements link target to new requirements doc location. |
| docs/getting-started/overview.md | Adjusts CTA buttons (adds Live Demo; removes install/requirements CTAs). |
| docs/getting-started/interactive-installation.md | Removes the English interactive installation page. |
| docs/getting-started/installation.md | Removes the English installation page. |
| docs/es/getting-started/interactive-installation.md | Repurposes content toward “Quick Installation” with setup.applyTemplates usage. |
| docs/es/developer-guide/etendo-classic/how-to-guides/how-to-use-setup-apply-templates.md | New Spanish how-to for setup.applyTemplates. |
| docs/developer-guide/etendo-classic/how-to-guides/how-to-use-setup-apply-templates.md | New English how-to for setup.applyTemplates. |
| docs/developer-guide/etendo-classic/how-to-guides/how-to-use-interactive-setup.md | New English how-to for interactive setup usage. |
| docs/developer-guide/etendo-classic/how-to-guides/how-to-configure-etendo-main-ui.md | New English guide for Main UI configuration and dev setup. |
| docs/developer-guide/etendo-classic/getting-started/upgrade/upgrade-etendo-to-any-version.md | Updates links to the new requirements page location. |
| docs/developer-guide/etendo-classic/getting-started/installation/requirements.md | New requirements/software stack page under developer guide. |
| docs/developer-guide/etendo-classic/getting-started/installation/local-development.md | New local development installation guide using setup.applyTemplates. |
| docs/developer-guide/etendo-classic/getting-started/installation/production-server.md | New server installation guide (ISO-centric) using setup.applyTemplates. |
| docs/developer-guide/etendo-classic/getting-started/installation/install-etendo-main-ui.md | Removes the old Main UI install page (replaced by the new “configure” guide). |
| docs/developer-guide/etendo-classic/getting-started/installation/install-etendo-development-environment.md | Removes the old dev-environment install page (replaced by “local-development”). |
Comments suppressed due to low confidence (1)
mkdocs.yml:1029
- The PR removes the top-level
getting-started/installation.md+getting-started/interactive-installation.mdpages (and the files are deleted), but there are still many in-repo links pointing to them (e.g.docs/index.md,docs/whats-new/etendo-news.md,docs/developer-guide/etendo-copilot/installation.md, etc.). This will introduce broken internal links on the site. Consider keeping the removed pages as thin “moved” stubs that point to the newlocal-development.md/production-server.md/ interactive setup docs, or update all inbound links in the same PR.
consent:
title: We value your privacy
description: >-
We use cookies and other tracking technologies to improve your browsing experience on our website, to show you personalized content and targeted ads, to analyze our website traffic, and to understand where our visitors are coming from. By clicking "Accept", you consent to our use of cookies. <a href="https://etendo.software/en/cookie-policy-2/" target="_blank">Cookie Policy</a>
actions:
- accept
- manage
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| The required technology stack depends on the target version. | ||
|
|
||
| - For Etendo versions prior to **Etendo 25**, the initial stack remains unchanged, For more information, visit: [Etendo 24 and Earlier - Software Stack](../../../../getting-started/requirements.md#etendo-24-and-earlier) | ||
| - For Etendo versions prior to **Etendo 25**, the initial stack remains unchanged, For more information, visit: [Etendo 24 and Earlier - Software Stack](../installation/requirements.md#etendo-24-and-earlier) |
Comment on lines
1192
to
1204
| - Etendo Copilot: | ||
| - ✨ Getting Started: user-guide/etendo-copilot/getting-started.md | ||
| - Setup and Usage: user-guide/etendo-copilot/setup-and-usage.md | ||
| - Bundles: | ||
| - Copilot Extensions: | ||
| - Overview: user-guide/etendo-copilot/bundles/overview.md | ||
| - SQL Expert: user-guide/etendo-copilot/bundles/sql-expert.md | ||
| - New UI: | ||
| - User Interface Improvements: user-guide/new-ui/ui-improvements.md | ||
|
|
||
| - Developer Guide: | ||
| - Overview: developer-guide/overview.md | ||
| - Etendo: |
Comment on lines
1
to
16
| @@ -8,18 +8,18 @@ tags: | |||
| - Configuración de PostgreSQL | |||
| - Entorno de Etendo | |||
| - Instalar | |||
| - Instalación interactiva | |||
| - Quick Installation | |||
|
|
|||
| status: beta | |||
| --- | |||
| # Instalar Etendo - Guía interactiva | |||
| # Install Etendo - Quick Installation Guide | |||
|
|
|||
Contributor
|
Warning Git Police 👮One or more commit messages do not meet the required standards. Please correct them.
|
1 similar comment
Contributor
|
Warning Git Police 👮One or more commit messages do not meet the required standards. Please correct them.
|
RomanMagnoli
force-pushed
the
feature/ETP-3291
branch
from
3e85a11 to
f124ca9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds comprehensive documentation for the
setup.applyTemplatesGradle task in Etendo and updates the documentation navigation to include this new guide. The new guide explains how to use the task, describes template formats and options, provides examples, and covers troubleshooting and CI/CD integration.Documentation Additions:
how-to-use-setup-apply-templates.md, detailing the usage of thesetup.applyTemplatesGradle task, including modes of operation (interactive, bundled, file, URL), template format, backup mechanism, and CI/CD integration. The guide also provides troubleshooting steps and example templates.Documentation Navigation Update:
mkdocs.ymlto include the new "How to Use Setup Apply Templates" guide in the developer how-to section, making it accessible from the documentation sidebar.Remaining: Check with the rest of the team the variables configured in templates and update de doc.