Bugfix/home docs

[Seburan]

Description

1. demo docs fixes :

• fix issue linked to the dev branch #624
• fix issue remove TODOs and graph source code #623
• fix issue Hard coded link #622
• fix issue home doc linked to the Dev branch #621

2. docusaurus config :

• docs : fix relative file paths and relative urls. Markdown file paths are preferred. see https://docusaurus.io/docs/next/markdown-features/links
• updated docusaurus config to throw an exception when Markdown links are broken

3. [home] strenghten nginx configuration

• upgrade nginx
• add nginx.conf directives for security and optimization (nginx was using the default config so far)

Affected services

• Home
• News
• Shop
• Travel
• DSP
• SSP
• ALL

Other:

[gemini-code-assist]

Hello @Seburan, I'm Gemini Code Assist¹! 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!

Summary of Changes

This pull request addresses several issues related to the home documentation, Docusaurus configuration, and Nginx configuration for the privacy sandbox demos. It includes fixes for broken links, updates to the Nginx configuration for enhanced security and optimization, and upgrades the Nginx version. The changes affect the Home service.

Highlights

• Documentation Fixes: The PR resolves multiple documentation issues by fixing relative file paths and URLs in the markdown files. It also updates image links to use relative paths instead of absolute URLs.
• Docusaurus Configuration: The Docusaurus configuration is updated to throw an exception when Markdown links are broken, ensuring link integrity. The trailingSlash option is enabled to add trailing slashes to URLs.
• Nginx Configuration: The Nginx configuration is strengthened by upgrading Nginx to version 1.27.5-alpine and adding directives for security and optimization. The configuration file is now directly copied to /etc/nginx/nginx.conf instead of using a template.
• Docker Compose Update: The docker-compose.yml file is updated to use the newer Nginx image version 1.27.5-alpine.

Changelog

Click here to see the changelog

• docker-compose.yml
  • Upgraded the Nginx image version from 1.22.1-alpine to 1.27.5-alpine.
• services/home/Dockerfile
  • Upgraded the base Nginx image from 1.25-alpine3.17 to 1.27.5-alpine.
  • Modified the Dockerfile to copy the custom Nginx configuration directly to /etc/nginx/nginx.conf.
  • Added an EXPOSE directive to expose port 8080 for Nginx.
  • Removed the use of Nginx templates.
• services/home/docs/demos/bidding-and-auction.md
  • Updated the image link for 'Bidding Auction API Flow' to use a relative path.
  • Replaced bash` with mermaid` for sequence diagrams.
  • Replaced the TODO comment with a full-sized diagram link.
  • Updated the link to construct-component-auction.ts to point to the correct commit.
• services/home/docs/demos/instream-video-ad.md
  • Updated links to other documentation pages to use relative paths.
  • Updated links to source code files to point to the correct commit.
  • Corrected the parsing link to the correct file video-ads.js.
• services/home/docs/demos/multi-piece-ad.md
  • Updated the link to the sequential auction setup demo to use a relative path.
• services/home/docs/demos/publisher-ad-quality-req.md
  • Updated the full-sized diagram link to point to the correct commit.
  • Updated links to other documentation pages to use relative paths.
• services/home/docs/demos/sequential-auction-setup.md
  • Updated links to other documentation pages to use relative paths.
  • Updated links to source code files to point to the correct commit.
• services/home/docs/intro.md
  • Updated documentation links to use .md extension.
• services/home/docusaurus.config.js
  • Enabled the trailingSlash option to add trailing slashes to URLs.
  • Changed onBrokenMarkdownLinks to throw an error instead of a warning.
• services/home/nginx.conf
  • Replaced the basic Nginx configuration with a more comprehensive configuration for security and optimization, including gzip compression, caching, and security headers.

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 is currently in preview and 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 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.

---

A link astray,
A broken path, a sad display,
Docs now aligned.

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. ↩

[gemini-code-assist]

Code Review

This pull request addresses several documentation issues and enhances the Nginx configuration for the home service. The changes include fixing broken links, updating Nginx to the latest version, and adding security and optimization directives. Overall, the changes seem beneficial for improving the documentation quality and the security posture of the home service.

Summary of Findings

• Nginx Configuration: The Nginx configuration has been significantly updated to include security and optimization directives. This is a positive step towards improving the service's security and performance. Ensure that all directives are properly configured and tested.
• Documentation Updates: The documentation updates address broken links and improve the overall quality of the documentation. Using relative file paths and URLs is a good practice for maintainability.
• Nginx version upgrade: The Nginx version has been upgraded to 1.27.5-alpine. This is a good practice to ensure that the service is running on the latest version with the latest security patches.

Merge Readiness

The pull request includes important bug fixes and enhancements to the home service. The Nginx configuration changes and documentation updates are valuable improvements. Before merging, ensure that the Nginx configuration is thoroughly tested and that all links in the documentation are working as expected. I am unable to approve this pull request, and recommend that others review and approve this code before merging.