Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add signposting after moving docs folder content #151

Merged
merged 4 commits into from
Nov 13, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
Everybody who uses this project is encouraged to contribute to this project. If you're part of the [alphagov GitHub organisation](https://www.github.com/alphagov) you probably have write access to this repo. If you don't, ask a GitHub admin or #tech-docs-format on Slack.

- Before adding your feature, [check the backlog to see if someone is already talking about it](https://github.com/alphagov/tech-docs-template/issues)
- If you add a new option to `config/tech-docs.yml`, make sure you [document the option in docs/configuration.md](docs/configuration.md)
- If you add a new option to the page frontmatter, make sure you [document the option in docs/frontmatter.md](docs/frontmatter.md)
- If you add a new option to `config/tech-docs.yml`, make sure you [document the new configuration option][configuration]
- If you add a new option to the page frontmatter, make sure you [document the new frontmatter configuration](docs/frontmatter.md)
- You can test your contribution using [unit tests](spec/govuk_tech_docs), [javascript tests](spec/javascripts) or [integration tests](spec/features)
- If your change is relevant to the users of the gem, add something to [CHANGELOG](CHANGELOG.md). You don't have to do this if it's just refactoring. Make sure that you include any upgrade instructions.

[configuration]: https://github.com/alphagov/tdt-documentation/blob/master/source/amend_project/configuration/index.html.md.erb
[frontmatter]: https://github.com/alphagov/tdt-documentation/blob/master/source/frontmatter.html.md.erb
227 changes: 1 addition & 226 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,228 +1,3 @@
# Configuration

You can configure the site using `config/tech-docs.yml`. [See the PaaS tech docs for an example](https://github.com/alphagov/paas-tech-docs/blob/master/config/tech-docs.yml).

These are all the available options:

## `ga_tracking_id`

Tracking ID from Google Analytics

```yaml
ga_tracking_id: UA-XXXX-Y
```

## `github_repo`

Your repository. Required if [show_contribution_banner](#show-contribution-banner) is true.

```yaml
github_repo: alphagov/example-repo
```

## `github_branch`

Your github branch name. Useful if your default branch is not named master.

```yaml
github_branch: source
```

## `google_site_verification`

Adds a [Google Site Verification code](https://support.google.com/webmasters/answer/35179?hl=en) to the meta tags.

```yaml
google_site_verification: TvDTuyvdstyusadrCSDrctyd
```

## `enable_search`

Enables search functionality. This indexes pages only and is not recommended for single-page sites.

```yaml
enable_search: true
```

## `header_links`

Right hand side navigation.

Example:

```yaml
header_links:
Documentation: /
```

## `footer_links`

Links to show in footer.

Example:

```yaml
footer_links:
Accessibility: /accessibility
```

## `host`

Host to use for canonical URL generation (without trailing slash).

Example:

```yaml
host: https://docs.cloud.service.gov.uk
```

## `collapsible_nav`

Enable collapsible navigation in the sidebar. Defaults to false;

```yaml
collapsible_nav: true
```

## `multipage_nav`

Enable multipage navigation in the sidebar. Defaults to false;

```yaml
multipage_nav: true
```

## `max_toc_heading_level`

Table of contents depth – how many levels to include in the table of contents. If your ToC is too long, reduce this number and we'll only show higher-level headings.

```yaml
max_toc_heading_level: 6
```

## `phase`

```yaml
phase: "Beta"
```

## `prevent_indexing`

Prevent robots from indexing (e.g. whilst in development)

```yaml
prevent_indexing: false
```

## `redirects`

A list of redirects, from old to new location. Use this to set up external
redirects or if [setting `old_paths` in the frontmatter](docs/frontmatter.md#old_paths) doesn't work.

```yaml
redirects:
/old-page.html: https://example.org/something-else.html
/another/old-page.html: /another/new-page.html
```

## `service_name`

The service name in the header.

Example:

```yaml
service_name: "Platform as a Service"
```

## `full_service_name`

The full service name (maybe with GOV.UK)

Example:

```yaml
full_service_name: "GOV.UK Pay"
```

## `service_link`

What the service name in the header links to.

default: '/'

```yaml
service_link: "/"
```

## `show_contribution_banner`

Show a block at the bottom of the page that links to the page source, so readers
can easily contribute back to the documentation. If turned on [github_repo](#github-repo) is
required.

Off by default.

```yaml
show_contribution_banner: true
github_repo: alphagov/example-repo
```

## `source_urls`

Customise the URLs that the contribution banner links to. Only useful if
[show_contribution_banner](#show_contribution_banner) is turned on. By default, "Report issue" links
to raising a GitHub issue but by modifying the `report_issue_url` it can link to an email address
or another page.

```yaml
source_urls:
report_issue_url: mailto:[email protected]
```

## `show_govuk_logo`

Whether to show the GOV.UK crown logo.

default: `true`

```yaml
show_govuk_logo: true
```

## `api_path`

Define a path to an Open API V3 spec file. This can be a relative file path or a URI to a raw file.

```yaml
api_path: ./source/pets.yml
```

## `owner_slack_workspace` and `default_owner_slack`

These attributes are used to specify the owner of a page. See the separate
[documentation for page expiry][expiry] for more details.

## `show_expiry`

Decides whether or not to show a red banner when the page needs to be reviewed.

If not present or set to `true`, the red banner will appear when the page needs to be reviewed. This is the default behaviour.

If set to `false`, the red banner will not appear when the page needs to be reviewed.

See the separate [documentation for page expiry][expiry] for more details.

[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review

## `show_review_banner`

Decides whether or not to display the page review banner, regardless of whether the page needs to be reviewed or not.

If not present or set to `true`, the banner will be displayed on the page. This is the default behaviour.

If set to `false`, the banner will not be displayed.

See the separate [documentation for page expiry][expiry] for more details.

[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
Content has been moved to alphagov/tdt-documentation: https://github.com/alphagov/tdt-documentation/pull/108/commits/e50c6bc0dd43b2f299444b7dc760e1a85edcb718
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be more useful to link the user to the live documentation site for these links (e.g. https://tdt-documentation.london.cloudapps.digital/amend_project/configuration/#configuration-options)?

Copy link
Author

@bravegrape bravegrape Nov 12, 2019

Choose a reason for hiding this comment

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

My reasoning for putting that link in was to explain why it was moved. But I think you're right, it's probably more helpful to tell users where the content was moved to.

How about changing it to something like:

This content has been moved to: https://tdt-documentation.london.cloudapps.digital/amend_project/configuration/#configuration-options

Do you think it's worth linking to the source file too?

Copy link
Author

Choose a reason for hiding this comment

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

Added links to where the content is published: 2441420

The pages have links to the alphagov/tdt-documentation repo as well as the contribution banner so it should be fairly straightforward to find the source.

Binary file removed docs/core-layout-without-sidebar.png
Binary file not shown.
Binary file removed docs/core-layout.png
Binary file not shown.
Binary file removed docs/expired-page.png
Binary file not shown.
Loading