Skip to content

Update next.js documentation example

Filip Aleksic requested to merge docs-faleksic-master-patch-64406 into master

What does this MR do?

The npm run build command is defined in the package.json as next build && next export. Since the create-next-app includes a dynamic route I've removed it as well as disabled optimized images since they do not work with static files:

/** @type {import('next').NextConfig} */
const nextConfig = {
  reactStrictMode: true,
  images: {
    unoptimized: true,
  },
  assetPrefix: "https://gitlab-gold.gitlab.io/faleksic-tests/public-group/gitlab-pages-testing/"

}
module.exports = nextConfig

We also need to include an assetPrefix to make it work. From the NextJS documentation:

While assetPrefix covers requests to _next/static, it does not influence the following paths:
- Files in the public folder; if you want to serve those assets over a CDN, you'll have to introduce the prefix yourself

Working example can be found here - https://gitlab-gold.gitlab.io/faleksic-tests/public-group/gitlab-pages-testing/

With the code behind it in - https://gitlab.com/gitlab-gold/faleksic-tests/public-group/gitlab-pages-testing

Related issues

#404603 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports