Skip to content

Conversation

@GauBen
Copy link
Member

@GauBen GauBen commented Sep 2, 2025

Description

As requested here https://github.com/Jahia/gautier-braindump/issues/37#issuecomment-3242665132, we will use the JSM repo to test the github action

This PR does that:

  • format markdown documents to be pushed correctly
  • added github workflows

Checklist

Source code

  • I've shared and documented any breaking change
  • I've reviewed and updated the jahia-depends

Tests

  • I've provided Unit and/or Integration Tests
  • I've updated the parent issue with required manual validations

Tip

Documentation to guide the reviews: How to do a code review

Copilot AI review requested due to automatic review settings September 2, 2025 09:31
@GauBen GauBen requested a review from a team as a code owner September 2, 2025 09:31
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR implements documentation publishing automation to Jahia's Academy platform. The documentation is reformatted from standalone markdown files to the YAML frontmatter structure required by the Academy, and a GitHub Actions workflow is added to push docs on releases.

  • Reformats all documentation with YAML frontmatter specifying page paths, titles, and templates
  • Adds GitHub Actions workflow to automatically publish documentation on releases
  • Updates internal navigation links to use relative paths instead of absolute paths

Reviewed Changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/README.md Transforms main docs page to tutorials homepage with YAML frontmatter
docs/3-reference/README.md Removes reference section index page
docs/3-reference/1-cnd-format/README.md Adds comment to exclude incomplete content from publishing
docs/2-guides/README.md Removes guides section index page
docs/2-guides/2-island-architecture/README.md Adds YAML frontmatter for client-side JavaScript documentation
docs/2-guides/1-building-a-feedback-form/README.md Adds YAML frontmatter and updates navigation links
docs/1-getting-started/README.md Removes getting started section index page
docs/1-getting-started/6-building-a-nav-bar/README.md Adds YAML frontmatter for navigation bar tutorial
docs/1-getting-started/5-view-content-in-full-page/README.md Adds YAML frontmatter and fixes relative navigation link
docs/1-getting-started/4-making-a-blog/README.md Adds YAML frontmatter and fixes relative navigation link
docs/1-getting-started/3-the-about-us-page/README.md Adds YAML frontmatter and fixes relative navigation link
docs/1-getting-started/2-making-a-hero-section/README.md Adds YAML frontmatter and fixes relative navigation link
docs/1-getting-started/1-dev-environment/README.md Adds YAML frontmatter and fixes relative navigation link
docs/1-getting-started/0-introduction/README.md Creates new introduction page with YAML frontmatter
.github/workflows/push-docs.yml Adds GitHub Actions workflow for automated documentation publishing

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@GauBen GauBen merged commit 5fe56ec into main Sep 2, 2025
14 checks passed
@GauBen GauBen deleted the push-docs branch September 2, 2025 12:37
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.

3 participants