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 synthetics multi factor authentication docs #4444

Merged

Conversation

vigneshshanmugam
Copy link
Member

Description

Add docs around the TOTP based MFA support in Synthetics elastic/synthetics#957 and elastic/synthetics#975

Documentation sets edited in this PR

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4334

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

@vigneshshanmugam vigneshshanmugam requested a review from a team as a code owner October 28, 2024 22:33
Copy link
Contributor

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.

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

Currently each section is on its own page (preview). I think they can go on one page (using the discrete tags below). What do you think?

docs/en/observability/synthetics-mfa.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/synthetics-mfa.asciidoc Outdated Show resolved Hide resolved
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Thanks for updating both content sets! I have a few recommendations.

docs/en/observability/synthetics-mfa.asciidoc Outdated Show resolved Hide resolved
docs/en/serverless/synthetics/synthetics-mfa.mdx Outdated Show resolved Hide resolved
docs/en/observability/synthetics-mfa.asciidoc Outdated Show resolved Hide resolved
docs/en/serverless/synthetics/synthetics-mfa.mdx Outdated Show resolved Hide resolved
docs/en/observability/synthetics-mfa.asciidoc Outdated Show resolved Hide resolved
docs/en/serverless/synthetics/synthetics-mfa.mdx Outdated Show resolved Hide resolved
docs/en/observability/synthetics-mfa.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/synthetics-mfa.asciidoc Outdated Show resolved Hide resolved
docs/en/serverless/synthetics/synthetics-mfa.mdx Outdated Show resolved Hide resolved
docs/en/serverless/synthetics/synthetics-mfa.mdx Outdated Show resolved Hide resolved
@bmorelli25 bmorelli25 added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify ci:doc-build labels Oct 31, 2024
Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
@vigneshshanmugam
Copy link
Member Author

vigneshshanmugam commented Oct 31, 2024

Currently each section is on its own page (preview). I think they can go on one page (using the discrete tags below). What do you think?

That was the intention, Thanks for catching it 👍🏽

@vigneshshanmugam vigneshshanmugam enabled auto-merge (squash) October 31, 2024 05:59
@elasticdocs
Copy link

elasticdocs commented Oct 31, 2024

🚀 Built elastic-dot-co-docs-preview-docs successfully!

Issues? Visit #next-docs in Slack

@vigneshshanmugam vigneshshanmugam merged commit 704f88d into elastic:main Nov 4, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request Nov 4, 2024
* add synthetics multi factor authentication docs

* apply suggestions from code review

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>

* Update docs/en/observability/synthetics-mfa.asciidoc

Co-authored-by: Colleen McGinnis <[email protected]>

---------

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>
Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 704f88d)

# Conflicts:
#	docs/en/observability/index.asciidoc
#	docs/en/serverless/serverless-observability.docnav.json
#	docs/en/serverless/synthetics/synthetics-command-reference.mdx
mergify bot pushed a commit that referenced this pull request Nov 4, 2024
* add synthetics multi factor authentication docs

* apply suggestions from code review

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>

* Update docs/en/observability/synthetics-mfa.asciidoc

Co-authored-by: Colleen McGinnis <[email protected]>

---------

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>
Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 704f88d)

# Conflicts:
#	docs/en/serverless/serverless-observability.docnav.json
#	docs/en/serverless/synthetics/synthetics-command-reference.mdx
mergify bot pushed a commit that referenced this pull request Nov 4, 2024
* add synthetics multi factor authentication docs

* apply suggestions from code review

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>

* Update docs/en/observability/synthetics-mfa.asciidoc

Co-authored-by: Colleen McGinnis <[email protected]>

---------

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>
Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 704f88d)

# Conflicts:
#	docs/en/serverless/serverless-observability.docnav.json
#	docs/en/serverless/synthetics/synthetics-command-reference.mdx
@vigneshshanmugam vigneshshanmugam deleted the add-synthetics-mfa-docs branch November 4, 2024 19:12
vigneshshanmugam added a commit that referenced this pull request Nov 4, 2024
…#4475)

* add synthetics multi factor authentication docs (#4444)

* add synthetics multi factor authentication docs

* apply suggestions from code review

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>

* Update docs/en/observability/synthetics-mfa.asciidoc

Co-authored-by: Colleen McGinnis <[email protected]>

---------

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>
Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 704f88d)

# Conflicts:
#	docs/en/serverless/serverless-observability.docnav.json
#	docs/en/serverless/synthetics/synthetics-command-reference.mdx

* Delete docs/en/serverless directory

---------

Co-authored-by: Vignesh Shanmugam <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
vigneshshanmugam added a commit that referenced this pull request Nov 4, 2024
#4476)

* add synthetics multi factor authentication docs (#4444)

* add synthetics multi factor authentication docs

* apply suggestions from code review

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>

* Update docs/en/observability/synthetics-mfa.asciidoc

Co-authored-by: Colleen McGinnis <[email protected]>

---------

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>
Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 704f88d)

# Conflicts:
#	docs/en/serverless/serverless-observability.docnav.json
#	docs/en/serverless/synthetics/synthetics-command-reference.mdx

* Delete docs/en/serverless directory

---------

Co-authored-by: Vignesh Shanmugam <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
bmorelli25 added a commit that referenced this pull request Nov 4, 2024
#4474)

* add synthetics multi factor authentication docs (#4444)

* add synthetics multi factor authentication docs

* apply suggestions from code review

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>

* Update docs/en/observability/synthetics-mfa.asciidoc

Co-authored-by: Colleen McGinnis <[email protected]>

---------

Co-authored-by: Emilio Alvarez Piñeiro <[email protected]>
Co-authored-by: Brandon Morelli <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 704f88d)

# Conflicts:
#	docs/en/observability/index.asciidoc
#	docs/en/serverless/serverless-observability.docnav.json
#	docs/en/serverless/synthetics/synthetics-command-reference.mdx

* Delete docs/en/serverless directory

* actually that was easy

---------

Co-authored-by: Vignesh Shanmugam <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: bmorelli25 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.15 Automated backport with mergify backport-8.16 Automated backport with mergify needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request]: Document MFA TOTP based Auth for Synthetics browser monitors
6 participants