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

Endpoint system requirements #5271

Merged
merged 2 commits into from
Jun 10, 2024
Merged

Conversation

natasha-moore-elastic
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic commented May 29, 2024

Resolves #4636. Adds Endpoint system requirements to ESS and serverless docs.

Previews:

@natasha-moore-elastic natasha-moore-elastic added Team: Endpoint Endpoint related issues Priority: High Issues that are time-sensitive and/or are of high customer importance Effort: Small Issues that can be resolved quickly Docset: Serverless Issues for Serverless Security Docset: ESS Issues that apply to docs in the Stack release v8.13.0 v8.14.0 v8.15.0 labels May 29, 2024
@natasha-moore-elastic natasha-moore-elastic self-assigned this May 29, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@elasticdocs
Copy link

elasticdocs commented May 29, 2024

🚀 Built co-preview-docs successfully!

Issues? Visit #next-docs in Slack

@natasha-moore-elastic natasha-moore-elastic marked this pull request as ready for review May 29, 2024 11:52
@natasha-moore-elastic natasha-moore-elastic requested a review from a team as a code owner May 29, 2024 11:52
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

It's not incorrect, but the table format used this way seems a little unexpected because it could only ever have one single row. I think rotating the table, so the left column has types of info and the right column has their values, is more typical, like this example.

docs/getting-started/elastic-endpoint-reqs.asciidoc Outdated Show resolved Hide resolved
@natasha-moore-elastic
Copy link
Contributor Author

It's not incorrect, but the table format used this way seems a little unexpected because it could only ever have one single row. I think rotating the table, so the left column has types of info and the right column has their values, is more typical, like this example.

I agree, @joepeeples – I tried to do that initially, and it works for ESS docs, but we don't seem to support headerless tables in serverless docs (I tried both regular MD syntax and the DocTable component). I suppose we can add a header with something like Requirement | Value as column titles?

@natasha-moore-elastic
Copy link
Contributor Author

@roxana-gheorghe, just to double-check, is there any information that we should add before the table (similar to what we have here)?

Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@natasha-moore-elastic natasha-moore-elastic merged commit 272fc61 into main Jun 10, 2024
4 checks passed
@natasha-moore-elastic natasha-moore-elastic deleted the issue-4636-endpoint-sys-reqs branch June 10, 2024 09:22
mergify bot pushed a commit that referenced this pull request Jun 10, 2024
* Endpoint system requirements

* Reformats table

(cherry picked from commit 272fc61)

# Conflicts:
#	docs/serverless/edr-install-config/deploy-endpoint-reqs.mdx
mergify bot pushed a commit that referenced this pull request Jun 10, 2024
* Endpoint system requirements

* Reformats table

(cherry picked from commit 272fc61)

# Conflicts:
#	docs/serverless/edr-install-config/deploy-endpoint-reqs.mdx
natasha-moore-elastic added a commit that referenced this pull request Jun 10, 2024
* Endpoint system requirements (#5271)

* Endpoint system requirements

* Reformats table

(cherry picked from commit 272fc61)

# Conflicts:
#	docs/serverless/edr-install-config/deploy-endpoint-reqs.mdx

* Delete docs/serverless directory and its contents

* Revert "Delete docs/serverless directory and its contents"

This reverts commit 9306bb5.

* Removes serverless folder

---------

Co-authored-by: natasha-moore-elastic <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Jun 10, 2024
* Endpoint system requirements (#5271)

* Endpoint system requirements

* Reformats table

(cherry picked from commit 272fc61)

# Conflicts:
#	docs/serverless/edr-install-config/deploy-endpoint-reqs.mdx

* Delete docs/serverless directory and its contents

* Revert "Delete docs/serverless directory and its contents"

This reverts commit 0573923.

* Removes serverless folder

---------

Co-authored-by: natasha-moore-elastic <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: natasha-moore-elastic <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docset: ESS Issues that apply to docs in the Stack release Docset: Serverless Issues for Serverless Security Effort: Small Issues that can be resolved quickly Priority: High Issues that are time-sensitive and/or are of high customer importance Team: Endpoint Endpoint related issues v8.13.0 v8.14.0 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request] Endpoint System Requirements
4 participants