!{title}

' # 2. Calls render_paths(doc) to process all endpoints # 3. Calls render_defs(doc) for schema definitions # 4. Returns formatted XML pass ``` -------------------------------- ### NEWS_DEPS Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-build-system.md Lists dependencies for news, index, and RSS transformations. This set includes common dependencies along with specific DTD and XSLT files for news content. ```makefile $(COMMON_DEPS) dtd/news.dtd xslt/news.xslt ``` -------------------------------- ### Verbose Build Output Command Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-build-system.md Runs the build process with verbose output enabled by setting the `V=1` variable. This provides detailed logging for debugging purposes. ```bash make V=1 ``` -------------------------------- ### Staging Deployment Hook Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-deployment.md A deployment hook script executed on the production host for staging deployments. ```bash /usr/local/bin/copy_draft.sh $(NGINX_ORG) ``` -------------------------------- ### YAML to XML Converter Build Rule Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/configuration.md A GNUmakefile rule to convert an OpenAPI 3.0 YAML specification into nginx-format XML documentation using a Python script. ```makefile genapi: python yaml/yaml2xml.py < yaml/nginx_api.yaml > xml/en/docs/api.xml ``` -------------------------------- ### Multiple Make Variable Overrides Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/configuration.md Apply multiple Make variable overrides simultaneously for custom build configurations. ```bash make OUT=/tmp NGINX_ORG=/var/www all ``` -------------------------------- ### Nginx Server Configuration Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/configuration.md Configures an Nginx server to listen on a specific port, handle static gzip compression, and serve content from different directories based on the request location. ```nginx server { listen 8080; gzip_static on; access_log /dev/stdout; default_type text/plain; location /img/ { root /var/www; } location /books/ { root /var/www/binary; } location = /favicon.ico { root /var/www/binary; } location / { if ( -d /var/www/gzip ) { root /var/www/gzip; # Use pre-compressed files if available } root /var/www/libxslt; # Fallback to uncompressed } } ``` -------------------------------- ### XSLScript Command-Line Invocation Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-xslscript.md Basic command to run the XSLScript tool. Specify options and an input file for conversion. ```bash perl tools/xslscript.pl [OPTIONS] [input_file] ``` -------------------------------- ### Check Rebuild Logs Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-shell-tools.md Command to check the last build status in a development container by examining the timestamps of output files. ```bash # Check last build status ls -lt /var/www/libxslt/ ``` -------------------------------- ### Nginx Configuration for Static Gzip Serving Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-deployment.md Nginx configuration block enabling static gzip serving. It prioritizes serving pre-compressed files from a 'gzip/' directory if available and the client accepts gzip encoding, falling back to uncompressed files otherwise. ```nginx location / { if ( -d /var/www/gzip ) { root /var/www/gzip; # Serve pre-compressed files } root /var/www/libxslt; } gzip_static on; # Enable static gzip serving ``` -------------------------------- ### Deployment Validation Script Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-shell-tools.md A bash script to validate deployment artifacts. It checks file sizes, the number of HTML files, and the presence of essential CSS files. ```bash #!/bin/bash # Check file sizes du -sh libxslt/ | grep -q "[0-9]" || { echo "No output"; exit 1; } # Check gzip [ $(find libxslt -name "*.html" | wc -l) -gt 100 ] || { echo "Insufficient HTML files"; exit 1; } # Check CSS [ -f libxslt/css/style.css ] || { echo "Missing CSS"; exit 1; } echo "Deployment validation passed" ``` -------------------------------- ### Restore Previous Version Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-deployment.md Restores a previously backed-up version of the website from a tar archive and reloads the Nginx service. ```bash tar xzf backup-20260527.tar.gz -C / systemctl reload nginx ``` -------------------------------- ### XSLScript Basic Instruction Syntax Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-xslscript.md Defines the general structure for XSLScript instructions with attributes and body content. ```xslscript X:instruction attribute="value" { body content } ``` -------------------------------- ### Check Gzip Files Count Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-deployment.md Counts the number of .gz files present in the gzip deployment directory to verify the compression deployment. ```bash find /var/www/nginx.org/gzip -name "*.gz" | wc -l ``` -------------------------------- ### Parallel Make Compilation Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/configuration.md Enables parallel compilation using the 'make -j' option to speed up build times. The number of jobs should ideally match the number of CPU cores. ```bash make -j4 all # Use 4 parallel jobs make -j8 gzip # 8 jobs for compression ``` -------------------------------- ### XSLScript Compilation Invocation Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/configuration.md Shows how to invoke the XSLScript compilation macro with input and output file arguments. ```makefile # Invocation: $(call XSLScript, input.xsls, output.xslt) ``` -------------------------------- ### XSLScript Parse Tree Structure for Instructions Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-xslscript.md Illustrates the internal representation of XSLScript instructions within the parse tree. ```perl ["X:instruction_name", attr1, value1, attr2, value2, ...] ``` -------------------------------- ### Convert YAML to XML Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-yaml2xml.md Invokes the YAML to XML converter using the build system. Input is read from stdin or a file, and output is redirected to stdout or a file. ```bash python yaml/yaml2xml.py < yaml/nginx_api.yaml > xml/en/docs/api.xml ``` -------------------------------- ### Production Docker Build Command Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/configuration.md Command to build the production Docker image for nginx.org, ensuring no cache is used. ```bash docker build --no-cache -t nginx.org:latest . ``` -------------------------------- ### Module Root Element Definition Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/types.md Defines nginx module reference documentation, including directives, blocks, and contexts. Used for module reference pages. ```xml ``` -------------------------------- ### Retrieve Definition Object from Reference Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-yaml2xml.md Retrieves the actual schema definition object from the OpenAPI document using a $ref object. ```python def node_from_ref(doc, obj): # Parameters: # - doc (dict) — Complete OpenAPI document # - obj (dict) — Object with '$ref' key # Returns: Referenced definition from doc['definitions'][name] pass ``` -------------------------------- ### Multi-Language Build Flow Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/architecture.md Shows the parallel processing of XML source for different languages (English and Russian) and the subsequent parallel XSLT processing to generate language-specific HTML. ```text ┌─→ xml/en/docs/ XML Source ─────┤ [english content] │ └─→ xml/ru/docs/ [russian content] ↓ [Parallel XSLT processing] ↓ libxslt/en/docs/ libxslt/ru/docs/ ``` -------------------------------- ### Project Listing Element Definition Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/types.md Defines the XML structure for listing related projects, including attributes for title, documentation URL, repository URL, logo, and description. ```xml ``` -------------------------------- ### Nginx Version Configuration XML Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/configuration.md XML file defining Nginx version information, including mainline, stable, and legacy versions, used for build processes and signing downloads. ```xml 1.27.0 1.26.0 1.24.0 ``` -------------------------------- ### Pattern Rule: CSS Copy Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/architecture.md A simple pattern rule to copy CSS files from their source directory to the output directory. ```makefile $(OUT)/css/%.css ← css/%.css ↓ cp (copy) ``` -------------------------------- ### Makefile Integration for YAML to XML Conversion Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-yaml2xml.md This Makefile rule invokes the Python script `yaml2xml.py` to convert an OpenAPI YAML file into an XML file, which is then used in the documentation build. ```makefile genapi: python yaml/yaml2xml.py < yaml/nginx_api.yaml > xml/en/docs/api.xml ``` -------------------------------- ### Edit and Rebuild nginx.org Content Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/INDEX.md Edit XML content files and observe auto-rebuilds via Docker Compose file watchers or manually rebuild the site. ```bash # Edit XML files in xml/en/ or xml/ru/ vim xml/en/docs/install.xml # Auto-rebuild via docker compose file watchers # Or manually rebuild make all # View at http://localhost:8001/ ``` -------------------------------- ### Docker Compose Development Configuration Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-deployment.md Configuration for the Docker Compose development environment, specifying ports, build context, file watching, and volume mounts. ```yaml services: nginx.org: ports: - 8001:8080 build: dockerfile: dev.Dockerfile develop: watch: - path: ./xml target: /var/www/xml action: sync - path: ./xsls target: /var/www/xsls action: sync - path: ./css target: /var/www/libxslt/css action: sync tmpfs: - /var/www/xslt volumes: - ./docker-nginx.conf:/etc/nginx/conf.d/default.conf - ./xslt/version.xslt:/var/www/xslt/version.xslt ``` -------------------------------- ### Compile XSLScript to XSLT Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/INDEX.md Use the XSLScript tool to compile input XSLScript files into output XSLT stylesheets. ```bash perl tools/xslscript.pl -o output.xslt input.xsls ``` -------------------------------- ### Sign Stable Release Command Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/INDEX.md This command is used to sign a stable release, typically after all other production steps are completed. ```bash make stable ``` -------------------------------- ### COMMON_DEPS Source: https://github.com/nginx/nginx.org/blob/main/_autodocs/api-reference-build-system.md Lists files required by all transformations in the build system. Ensure these files are present before running any build target. ```makefile xml/banner.xml xml/menu.xml xml/i18n.xml dtd/content.dtd xslt/dirname.xslt xslt/link.xslt xslt/style.xslt xslt/body.xslt xslt/menu.xslt xslt/content.xslt ```

!{.}

By <% !{.} %>