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

[Docs migration] Cleans up investigation tools files - pt 1 #498

Merged
merged 41 commits into from
Feb 25, 2025

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Feb 19, 2025

Addresses part of #559 by doing the following:

  • Removes raw migrated Serverless files that are no longer being used.
    NOTE: With the exception of the Timeline page, I'm using this PR to remove raw migrated serverless files only. After all of the my pages have been properly aligned and version, I'll create a follow-up PR to remove the remaining serverless images that we're no longer using.
  • Adds anchors where missing and updates anchors that start with an underscore.
  • Makes minor inline adjustments to the files that were labeled as "lift-and-shift" where appropriate.

Affected pages:

@nastasha-solomon
Copy link
Contributor Author

nastasha-solomon commented Feb 19, 2025

Had to re-add the following svg files because they were still being referenced in other raw migrated Serverless files.

serverless-plusInCircle.svg is referenced on:

  • Line 56 in raw-migrated-files/docs-content/serverless/security-view-alert-details.md
  • Line 57 in raw-migrated-files/docs-content/serverless/security-view-alert-details.md
  • Line 73 in raw-migrated-files/docs-content/serverless/security-alerts-manage.md
  • Line 224 in raw-migrated-files/docs-content/serverless/security-alerts-manage.md
  • Line 58 in raw-migrated-files/docs-content/serverless/observability-discover-and-explore-logs.md

serverless-gear.svg is referenced on:

  • Line 64 in raw-migrated-files/docs-content/serverless/attack-discovery.md
  • Line 63 in raw-migrated-files/docs-content/serverless/security-session-view.md

serverless-cross.svg is referenced on:

  • Line 71 in raw-migrated-files/docs-content/serverless/security-alerts-manage.md

serverless-timeline.svg is referenced on:

  • Line 18 in raw-migrated-files/docs-content/serverless/security-detection-response-dashboard.md
  • Line 51 in raw-migrated-files/docs-content/serverless/security-detection-entity-dashboard.md
  • Line 71 in raw-migrated-files/docs-content/serverless/security-detection-entity-dashboard.md
  • Line 37 in raw-migrated-files/docs-content/serverless/security-examine-osquery-results.md
  • Line 20 in raw-migrated-files/docs-content/serverless/security-cases-open-manage.md
  • Line 101 in raw-migrated-files/docs-content/serverless/security-ai-assistant.md

Commenting these refs out might be a temporary workaround. Another option is to remove the images in a separate PR.

In any case, we should only delete these images after we delete the raw migrated files that contain references to them.

@nastasha-solomon nastasha-solomon changed the title Cleans up investigation tools files Cleans up investigation tools files - pt 1 Feb 21, 2025
@nastasha-solomon nastasha-solomon marked this pull request as ready for review February 21, 2025 04:47
@nastasha-solomon nastasha-solomon requested a review from a team February 21, 2025 04:47
@nastasha-solomon nastasha-solomon removed the request for review from a team February 21, 2025 14:34
@nastasha-solomon nastasha-solomon marked this pull request as draft February 21, 2025 14:34
@nastasha-solomon nastasha-solomon changed the title Cleans up investigation tools files - pt 1 [Docs migration] Cleans up investigation tools files - pt 1 Feb 21, 2025
@nastasha-solomon nastasha-solomon marked this pull request as ready for review February 21, 2025 20:14
@nastasha-solomon nastasha-solomon requested a review from a team February 21, 2025 20:14
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic left a comment

Choose a reason for hiding this comment

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

Looks great!
I noticed that inline images are displayed on a separate line – I think that might be a wider issue since it's the same in the internal docs.

@nastasha-solomon
Copy link
Contributor Author

I noticed that inline images are displayed on a separate line – I think that might be a wider issue since it's the same in the internal docs.

It's a wider issue -- it appears across all of the pages that I've updated so far. I'll bring this up the V3 docs channel when I have a chance today.

@nastasha-solomon nastasha-solomon merged commit ee10feb into main Feb 25, 2025
5 checks passed
@nastasha-solomon nastasha-solomon deleted the rip-serverless-files-pt3 branch February 25, 2025 03:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants