Skip to content

222 improve installation questions - #270

Merged
JC-DSIT merged 6 commits into
mainfrom
222-improve-installation-questions
Aug 26, 2026
Merged

222 improve installation questions#270
JC-DSIT merged 6 commits into
mainfrom
222-improve-installation-questions

Conversation

@JC-DSIT

@JC-DSIT JC-DSIT commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

What changed

  • References to PaaS and supporting files have been removed.
  • Installation questions changed to be more simple to understand
  • Config uses more dynamic defaults

Related issue or tracking reference

You should have an open GitHub issue that this PR will fix.

Include screenshots, logs, or rendered output if this change affects layout or behaviour.

Questions:

**What will the URL of your documentation be, for example https://example-docs.gov.uk?
You can change this later in config/tech-docs.yml.**
**Documentation URL:** https://my-new-documentation.gov.uk
**What is the name of the service or API your documentation is about, for example Data sharing service?
You can change this later in config/tech-docs.yml.
Service Name:** Fancy new service
**What is the URL for the service your documentation is about, for example https://new-service.gov.uk?
You can change this later in config/tech-docs.yml.
Service URL:** https://service-you-never-knew-you-needed.gov.uk
**Will you be using the GOV.UK logo?** no
      create  config/tech-docs.yml
       exist  source
      create  source/API-reference.html.md.erb
      create  source/get-started.html.md.erb
      create  source/how-the-api-works.html.md.erb
      create  source/how-to-do-a-task.html.md.erb
      create  source/index.html.md.erb
      create  source/support.html.md.erb
      create  source/test-your-integration.html.md.
1/lib/ruby/site_ruby/3.3.0/rubygems/platform.rb:288: warning: previous definition of X64_LINUX_MUSL was here
Bundle complete! 4 Gemfile dependencies, 62 gems now installed.

Resulting config

host: https://my-new-documentation.gov.uk

# Header-related options
show_govuk_logo: false
service_name: Fancy new service
service_link: https://service-you-never-knew-you-needed.gov.uk
phase: Beta

# Links to show on right-hand-side of header
header_links:
  About: https://service-you-never-knew-you-needed.gov.uk/about
  Get Started: https://service-you-never-knew-you-needed.gov.uk/get-started
  Documentation: https://my-new-documentation.gov.uk
  Support: https://service-you-never-knew-you-needed.gov.uk/support
...

Checklist

Before you request approval you should confirm that:

  • the pull request has a clear title with a short description about the update in the documentation
  • GitHub actions all pass
  • you have tested the changes with a fresh build against the latest version of the tech-docs-gem
  • you have linked this PR to an issue (or explained why none exists)
  • you have updated documentation if needed

@JC-DSIT JC-DSIT linked an issue Aug 25, 2026 that may be closed by this pull request
@JC-DSIT
JC-DSIT requested a review from jackhobson August 26, 2026 10:42

@jackhobson jackhobson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

All looks good to me.

@JC-DSIT
JC-DSIT merged commit edb2d95 into main Aug 26, 2026
4 checks passed
@JC-DSIT
JC-DSIT deleted the 222-improve-installation-questions branch August 26, 2026 11:36
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.

Improve installation questions

2 participants