<DocsPage> ComponentWe have a lot of docs sites, all of which render content in exactly the same way. This component is a minimal abstraction of that rendering, and is intended to be used entirely as a template for all documentation content.
<DocsPageproduct={{ name: 'Nomad', slug: 'nomad' }}baseRoute='docs'showVersionSelect={false /* process.env.ENABLE_VERSIONED_DOCS === "true" */}// pass in the results of executing the 'generateStaticProps' function from '@hashicorp/react-docs-page/server'staticProps={staticPropsResult}><h2 class="g-type-display-3"><a class="__permalink-h" href="#agent" aria-label="agent permalink">»</a><a class="__target-h" id="agent" aria-hidden=""></a>Agent</h2><p>An agent is the long running daemon on every member of the Consul cluster. It is started by running <code>consul agent</code>. The agent is able to run in either <em>client</em> or <em>server</em> mode. Since all nodes must be running an agent, it is simpler to refer to the node as being either a client or server, but there are other instances of the agent. All agents can run the DNS or HTTP interfaces, and are responsible for running checks and keeping services in sync.</p><h2 class="g-type-display-3"><a class="__permalink-h" href="#client" aria-label="client permalink">»</a><a class="__target-h" id="client" aria-hidden=""></a>Client</h2><p>A client is an agent that forwards all RPCs to a server. The client is relatively stateless. The only background activity a client performs is taking part in the LAN gossip pool. This has a minimal resource overhead and consumes only a small amount of network bandwidth.</p></DocsPage>
| Name | Description |
|---|---|
product*string | The name and slug of the product this page is being rendered for. The slug is used for the Edit this page link.Object contains nested props, see below: |
product.name*string | Human-readable proper case product name. Used for the page <title /> and og:site_name. |
product.slugstring | A lower-case product identifier to pull in respective theme colors. The default is hashicorp blue. |
baseRoute*string | The path this page is rendering under, for example "docs" or "api-docs". Passed directly to the baseRoute prop of @hashicorp/react-docs-sidenav. |
showEditPageboolean | If true, an Edit this page link will appear on the bottom right of each page. |
showVersionedDocsboolean | If true, a version select option will be displayed. Defaults to process.env.ENABLE_VERSIONED_DOCS === "true" |
additionalComponentsobject | Object containing additional components to be made available within mdx pages. Uses the format { [key]: Component }, for example, { TestComponent: () => <p>hello world</p> } |
staticProps*object | Directly pass the return value of server/generateStaticProps in here.Object contains nested props, see below: |
staticProps.githubFileUrlstring | A link to the page's associated .mdx file on GitHub. Used for the Edit this page link. |
staticProps.mdxSource*object | Data returned from running next-mdx-remote/serialize on the page's .mdx file contents. |
staticProps.frontMatter*object | Frontmatter object parsed from the page's .mdx file.Object contains nested props, see below: |
staticProps.frontMatter.canonical_urlstring | Optional canonical URL. Passed directly to @hashicorp/react-head. |
staticProps.frontMatter.description*string | Used for the <meta name="description" />. Passed directly to @hashicorp/react-head. |
staticProps.frontMatter.page_title*string | Used to construct the meta <title /> tag, then passed to @hashicorp/react-head. |
staticProps.currentPathstring | Path to the current page, relative to the baseRoute. Used to highlight the current page. |
staticProps.navData*object | Tree of navigation data to render. See docs-sidenav/types.js for details. |
staticProps.versions*Array | Array of version options Array members must be of the type below: |
staticProps.versions[x]object | Object contains nested props, see below: |
staticProps.versions[x].namestring | A version’s programmatic value |
staticProps.versions[x].labelstring | A version’s human-friendly display value |
algoliaConfigobject | Optional Algolia configuration to pass to the react-search component. If omitted, will default to .env variables. Any of the properties can be omitted, and will fall back to .env variables. Object contains nested props, see below: |
algoliaConfig.appIdstring | The ID of the target Algolia application. |
algoliaConfig.indexNamestring | The name of the index to search. |
algoliaConfig.searchOnlyApiKeystring | A publishable search-only API key that can access the provided application and index. |