NVIDIA Corporation

NVIDIA GitHub Pages

This repository provides the sitemap index and fallback redirects for https://nvidia.github.io/. Individual projects maintain their own documentation sites and sitemaps.

Add a sitemap entry

  1. Publish a sitemap for your project, for example https://nvidia.github.io/ProjectName/sitemap.xml. Confirm that it returns HTTP 200 and valid sitemap XML containing the project’s canonical page URLs.

  2. Add a <sitemap> entry inside the existing <sitemapindex> in sitemap.xml:

    <sitemap>
  <loc>https://nvidia.github.io/ProjectName/sitemap.xml</loc>
</sitemap>

    For example, the complete index would look like this:

    <?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <sitemap>
    <loc>https://nvidia.github.io/AnotherProject/sitemap.xml</loc>
  </sitemap>
  <sitemap>
    <loc>https://nvidia.github.io/ProjectName/sitemap.xml</loc>
  </sitemap>
</sitemapindex>

Use an absolute HTTPS URL with the project’s exact path and capitalization. For this workflow, the sitemap must be hosted under https://nvidia.github.io/ and use <urlset> to list page URLs. The root index references sitemap files, not individual pages or other sitemap indexes. Projects hosted on other domains should configure sitemap discovery on their own domain.

The robots.txt already points to the root sitemap index, so adding a project does not require a change to that file. Keep each project’s sitemap up to date in its own repository. See Google’s sitemap index guidance and restriction on nested sitemap indexes.

Add a fallback redirect

Add an entry to the redirects object in 404.html. The key is the first URL path segment after https://nvidia.github.io/, and the value is the destination base URL.

For example, to redirect /OldProject to /NewProject, add the following after the existing entries, including a comma after the previous entry:

var redirects = {
    // Existing entries remain here.
    'IsaacTeleop': 'https://nvidia.github.io/IsaacCapture',
    'OldProject': 'https://nvidia.github.io/NewProject'
};

Use the old project’s exact capitalization for the key, without slashes. Use an absolute destination URL without a trailing slash, query string, or fragment.

The handler appends the remaining path, query string, and URL fragment:

https://nvidia.github.io/OldProject/guide/install.html?version=latest#linux
→ https://nvidia.github.io/NewProject/guide/install.html?version=latest#linux

Confirm that the destination serves the corresponding paths. If the new site uses a different page structure, this base-URL mapping alone will not translate those paths. Unmatched first path segments fall back to https://www.nvidia.com.

These redirects run in the browser when GitHub Pages serves this 404.html. They do not override existing pages or return an HTTP 301/308 redirect.

Verify and publish