Skip to content

Conversation

simon-dew
Copy link
Contributor

@simon-dew simon-dew commented Aug 16, 2024

Jira issue: DOC-12443

This PR doesn't add any new info but reorganizes the GSI devex docs, as a preliminary to adding GSI vector indexes.

  • It moves most of the GSI docs out of learn:services-and-indexes/indexes into a new top-level indexes module. This means that the learn module is no longer split between docs-server and docs-devex, which was confusing.
  • It updates page aliases of the GSI docs to include the old locations.
  • It updates links to the partials, examples, and images, which have of course also moved along with the GSI pages.
  • It updates links to all of the GSI pages throughout the devex docs — not really necessary, because we have the page aliases, but makes things easier for authors in the future.
  • It moves the overall indexes concept doc, which I think really does belong in the learn module, back to the docs-server repo.
  • It deletes some unused images.

Why is the top-level indexes module called that, rather than say gsi? Because by doing so it revives an old coordinate where some of these pages were stored originally. This enables us to remove some old page aliases, even as we're adding new ones, mindful of the advice that we want to keep page alias proliferation to a minimum.

I'll merge these changes into the capella branch and may have to make some follow-up changes in docs-capella at that time.

Docs preview: Primary and Secondary Index Reference — shouldn't actually look any different from before
Credentials: Preview docs for internal review

This PR must be merged at the same time as the following:

@simon-dew simon-dew marked this pull request as ready for review August 19, 2024 16:51
@simon-dew simon-dew requested review from a team and osfameron August 19, 2024 16:51
@simon-dew simon-dew merged commit a9293d7 into release/7.7 Aug 20, 2024
@simon-dew simon-dew deleted the DOC-12443 branch August 20, 2024 19:14
simon-dew added a commit that referenced this pull request Sep 9, 2025
* Move pages to Indexes
* Move diagrams to Indexes
* Move examples to Indexes
* Move images to Indexes
* Move indexes concept doc back to docs-server
* Remove unused image files
* Update page aliases
* Update links to GSI pages
* Update coordinates of example files
* Update GSI image coordinates
* Update GSI diagram coordinates
* Driveby fix unsupported icons
* Minor changes to indexing overview and content order
* Move covering indexes, group agg pushdown
* Update links to covering indexes, grouping and agg pushdown
* Driveby fix broken link
simon-dew added a commit that referenced this pull request Sep 11, 2025
* Move pages to Indexes
* Move diagrams to Indexes
* Move examples to Indexes
* Move images to Indexes
* Move indexes concept doc back to docs-server
* Remove unused image files
* Update page aliases
* Update links to GSI pages
* Update coordinates of example files
* Update GSI image coordinates
* Update GSI diagram coordinates
* Driveby fix unsupported icons
* Minor changes to indexing overview and content order
* Move covering indexes, group agg pushdown
* Update links to covering indexes, grouping and agg pushdown
* Driveby fix broken link
sarahlwelton pushed a commit that referenced this pull request Sep 24, 2025
* Move pages to Indexes
* Move diagrams to Indexes
* Move examples to Indexes
* Move images to Indexes
* Move indexes concept doc back to docs-server
* Remove unused image files
* Update page aliases
* Update links to GSI pages
* Update coordinates of example files
* Update GSI image coordinates
* Update GSI diagram coordinates
* Driveby fix unsupported icons
* Minor changes to indexing overview and content order
* Move covering indexes, group agg pushdown
* Update links to covering indexes, grouping and agg pushdown
* Driveby fix broken link
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