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

Fix doc links for all deployments #167859

Open
JordanSh opened this issue Oct 3, 2023 · 3 comments
Open

Fix doc links for all deployments #167859

JordanSh opened this issue Oct 3, 2023 · 3 comments
Assignees
Labels
Team:Cloud Security Cloud Security team related technical debt Improvement of the software architecture and operational architecture

Comments

@JordanSh
Copy link
Contributor

JordanSh commented Oct 3, 2023

Summary

We have some documentation links in the deployments forms that need updating.

I've mapped them all with current values. @tinnytintin10, if you could please go over them and create a new list with the updated values so we can open a PR to make alignments.

AWS:

  1. Getting Started

  2. Cloud Formation Documentation

  3. Manual Documentation

GCP:

  1. Google Cloud Shell Documentation

  2. Manual Documentation

Azure:

  1. Getting Started

  2. ARM Template Documentation

  3. Manual Documentation


@tinnytintin10 I also want to make another suggestion, to replace the generic "getting started guide" and "documentation" texts with the corresponding links.

for example in cloud formation, instead of:

Read the documentation for more details

we can do:

Refer to AWS Cloud Formation for more details


Regarding implementation, its time we introduce a shared object that contains all the links and their labels. so this should be done as part of this task

Also, links should use https://links.elastic.dev/ shorten versions

@JordanSh JordanSh changed the title [Cloud Security] Fix links for all deployments [Cloud Security] Fix doc links for all deployments Oct 3, 2023
@botelastic botelastic bot added the needs-team Issues missing a team label label Oct 3, 2023
@JordanSh JordanSh added Team:Cloud Security Cloud Security team related Feature:Cloud-Security Cloud Security related features 8.11 candidate and removed needs-team Issues missing a team label labels Oct 3, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-cloud-security-posture (Team:Cloud Security)

@JordanSh JordanSh self-assigned this Oct 3, 2023
@kfirpeled kfirpeled added 8.12 candidate technical debt Improvement of the software architecture and operational architecture and removed 8.11 candidate Feature:Cloud-Security Cloud Security related features labels Oct 4, 2023
@kfirpeled
Copy link
Contributor

moved from sprint 33

@kfirpeled
Copy link
Contributor

Deprioritized from 8.14 due to other features
cc: @smriti0321, @JordanSh

@acorretti acorretti changed the title [Cloud Security] Fix doc links for all deployments Fix doc links for all deployments Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Cloud Security Cloud Security team related technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Development

No branches or pull requests

3 participants