Docs SEO: Update Configuration section to improve search engine optimization

[aimeeu]

Description

• Front matter description updates for search engine optimization.
• I did not edit page content because that's out of scope for this effort.
• A member of the Runtime Education team will review all SEO PRs.

Links

Jira: CE-775

Contributor Checklist

• Changelog Entry If this PR changes user-facing behavior, please generate and add a
  changelog entry using the make cl command.
• Testing Please add tests to cover any new functionality or to demonstrate bug fixes and
  ensure regressions will be caught.
• Documentation If the change impacts user-facing functionality such as the CLI, API, UI,
  and job configuration, please update the Nomad website documentation to reflect this. Refer to
  the website README for docs guidelines. Please also consider whether the
  change requires notes within the upgrade guide.

Reviewer Checklist

• Backport Labels Please add the correct backport labels as described by the internal
  backporting document.
• Commit Type Ensure the correct merge method is selected which should be "squash and merge"
  in the majority of situations. The main exceptions are long-lived feature branches or merges where
  history should be preserved.
• Enterprise PRs If this is an enterprise only PR, please add any required changelog entry
  within the public repository.

[philrenaud]

Oh, neat. Does this mean this'll be more likely to come up for searches beginning with "How do I...." given the "Use... to..." answers?

LGTM!

[aimeeu]

Oh, neat. Does this mean this'll be more likely to come up for searches beginning with "How do I...." given the "Use... to..." answers?

LGTM!

I'm following description templates created by the Education team so only time will tell :)

[boruszak]

I left three suggestions on the first three descriptions with longer comments that explain the kinds of things we should be thinking about when updating descriptions for SEO. Your current edits are more focused on the style guide & active voice. But active voice isn't going to impact SEO.

This page from Google's SEO docs is their summary. The use quality descriptions subsection may be a useful resource.

[boruszak]

Suggested change

	Use the "acl" block to configure the Nomad agent to enable ACLs and tune various parameters.
	Configure Nomad's Access Control List (ACL) system behavior in the "acl" block of a Nomad agent configuration. You can change parameters that enable ACL enforcement, tune the cache for token, role, and policy TTLs, and change token replication and expiration values.

A few suggestions to improve these for SEO specifically:

• Use distinct phrasings and abbreviations and their permutations for variation and search match breadth. In this instance it's spelling out "Access Control List" that's needed.
• For configuration reference pages, explicitly state what you're configuring in the first sentence. In this instance, "acl block of a Nomad agent configuration." As opposed to, say, a job or task group configuration.
• Summarize the content of the page in the description. You don't have to capture everything. But skim the content and describe the information that is on the page. Right now you're burying everything under "tune various parameters" but briefly keywording these parameters is the thing that improves the SEO. So if a user was trying to search something like "Nomad ACL cached token TTL," my suggestions make this page responsive to those terms (on both Google and the internal search tool).

[boruszak]

Suggested change

	Use the "audit" block to configure the Nomad agent's audit logging
	behavior. Audit logging is available exclusively for Enterprise users.
	Configure audit logging behavior in the "audit" block of a Nomad agent configuration. You can enable audit logs, define a sink to stream audit logs to, and change filter rules to exclude events from the audit log with configuration and audit log format reference.

Suggestions for a slightly longer description that also tries to summarize the content of the page. A few additional notes.

• Enterprise availability does not matter for SEO and page descriptions. These changes are meant to pack these descriptions full of words that make them better matches for search results.
• I included a mention of the audit log format, because that's distinct reference information that someone might search for. The "awkwardness" reflects that this might not be the best location for this information and that it should be moved to another page. That's a change for another time, though. For SEO purposes, the awkward construction will do.

[boruszak]

Suggested change

	Use the "autopilot" block to configure the Nomad agent's Autopilot
	Configure settings for Nomad Autopilot features in the "autopilot" block of a Nomad agent configuration. You can enable dead server cleanup and redundancy zones, or tune Raft settings for stable server introduction.

In these suggestions, I'm again focusing on what the user wants to do with the information on the page. "Autopilot" doesn't mean much for the SEO. So why would someone be trying to find this page? What kinds of terms or phrases would help someone find this page if it had the information that was responsive to their situation?

That's a good way to think about what to write in these descriptions. "If this page and the content already on it had the exact information a user needed, what kinds of things would they be searching for?"

The suggestions I make result in a page description that is an even higher match for "dead server cleanup" - and this page is what they need when they configure that setting.