Skip to content

Website: Update software catalog url and mentions. - #30562

Merged
eashaw merged 5 commits into
mainfrom
website-update-software-catalog-mentions
Jul 9, 2025
Merged

Website: Update software catalog url and mentions.#30562
eashaw merged 5 commits into
mainfrom
website-update-software-catalog-mentions

Conversation

@eashaw

@eashaw eashaw commented Jul 3, 2025

Copy link
Copy Markdown
Contributor

Closes: https://github.com/fleetdm/confidential/issues/10867

Changes:

  • Updated the route for the /app-library page and app details pages to be at /software-catalog and added redirects.
  • Updated places where we mentioned the app library to say "software catalog" instead.

Summary by CodeRabbit

  • New Features

    • Updated all references and navigation paths from "app library" to "software catalog" across the website.
    • Updated internal links, breadcrumbs, and share URLs to use the new "/software-catalog" path.
    • Added redirects from old "app-library" URLs to the new "software-catalog" URLs for seamless navigation.
  • Style

    • Updated descriptive text and metadata to reflect the new "software catalog" terminology throughout the site.

@coderabbitai

coderabbitai Bot commented Jul 3, 2025

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes systematically rename all references to "app library" to "software catalog" throughout the project. This includes updates to route paths, navigation links, metadata, descriptive text, and internal URLs. Redirects are added for legacy paths, and all user-facing content and navigation now reference "software catalog" instead of "app library."

Changes

Files/Paths Change Summary
website/api/controllers/download-sitemap.js Updated hard-coded HTML page path from /app-library to /software-catalog in sitemap generation.
website/api/controllers/view-app-details.js Changed comments and metadata from "app library" to "software catalog."
website/assets/js/components/docs-nav-and-search.component.js Changed "Software" nav link from /app-library to /software-catalog.
website/config/routes.js Renamed all "app-library" routes to "software-catalog", updated metadata, and added redirects for old paths.
website/views/layouts/layout.ejs Updated dropdown menu text from "app library" to "software catalog."
website/views/pages/app-details.ejs Updated all internal/share URLs from /app-library to /software-catalog.
website/views/pages/app-library.ejs Changed app card links from /app-library/<id> to /software-catalog/<id>.
website/views/pages/software-management.ejs Changed paragraph text from "curated app library" to "curated software catalog."

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WebServer
    participant Controller
    participant View

    User->>WebServer: GET /app-library or /app-library/:appIdentifier
    WebServer->>WebServer: Redirect to /software-catalog or /software-catalog/:appIdentifier

    User->>WebServer: GET /software-catalog
    WebServer->>Controller: view-app-library
    Controller->>View: Render software catalog page
    View-->>User: Display software catalog

    User->>WebServer: GET /software-catalog/:appIdentifier
    WebServer->>Controller: view-app-details
    Controller->>View: Render app details page
    View-->>User: Display app details
Loading

Poem

🐇
Goodbye, dear "app library,"
"Software catalog" is now our song.
Routes and links have changed their tune,
Breadcrumbs, cards, and menus too—
With every hop, the words are new!
The catalog grows, the bunnies cheer,
For software’s future is bright and clear!

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch website-update-software-catalog-mentions

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🔭 Outside diff range comments (1)
website/api/controllers/download-sitemap.js (1)

111-113: Per-app URLs in sitemap still point to /app-library
These links will 404 after the rename.

-      sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+`/app-library/${appPage.identifier}`)}</loc></url>`;
+      sitemapXml +=`<url><loc>${_.escape(sails.config.custom.baseUrl+`/software-catalog/${appPage.identifier}`)}</loc></url>`;
🧹 Nitpick comments (3)
website/assets/js/components/docs-nav-and-search.component.js (1)

76-80: Remove duplicate 'software' entry in searchIndexesThatExist
software appears twice; it’s harmless but untidy and could mislead future refactors.

-      let searchIndexesThatExist = ['docs', 'software', 'queries', 'vitals', 'policies', 'tables', 'handbook', 'software'];
+      let searchIndexesThatExist = ['docs', 'software', 'queries', 'vitals', 'policies', 'tables', 'handbook'];
website/views/layouts/layout.ejs (1)

454-455: Script for legacy page name — decide if still needed
app-library.page.js is still loaded even though the public route is now /software-catalog.
If the JS file has also been renamed or duplicated, update the reference to avoid an extra request / dead code.

website/views/pages/app-library.ejs (1)

20-21: Path corrected, but component/page id/name is now misleading
The outer <div id="app-library"> and filename still say “app-library”.
Consider renaming to avoid confusion for future contributors.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f0d3809 and 7a34715.

📒 Files selected for processing (8)
  • website/api/controllers/download-sitemap.js (1 hunks)
  • website/api/controllers/view-app-details.js (2 hunks)
  • website/assets/js/components/docs-nav-and-search.component.js (1 hunks)
  • website/config/routes.js (4 hunks)
  • website/views/layouts/layout.ejs (1 hunks)
  • website/views/pages/app-details.ejs (3 hunks)
  • website/views/pages/app-library.ejs (1 hunks)
  • website/views/pages/software-management.ejs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build-binaries
  • GitHub Check: build (20.x)
  • GitHub Check: build-and-check
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (go)
🔇 Additional comments (9)
website/views/pages/software-management.ejs (1)

7-7: Copy update correct and consistent
Terminology swap reads well and aligns with the rest of the renaming work.

website/assets/js/components/docs-nav-and-search.component.js (1)

42-42: Href update LGTM
Route now points at /software-catalog, matching the new URLs.

website/views/layouts/layout.ejs (1)

211-212: Dropdown copy updated correctly
Text now references “software catalog”.

website/api/controllers/download-sitemap.js (1)

77-78: Good: overview URL added to sitemap

website/views/pages/app-details.ejs (1)

7-7: LGTM! Consistent URL updates across the template.

All URL references have been correctly updated from /app-library to /software-catalog, including breadcrumb navigation, internal links, and social share URLs. The changes maintain existing functionality while implementing the new URL structure consistently.

Also applies to: 32-32, 55-57

website/api/controllers/view-app-details.js (1)

14-14: LGTM! Terminology correctly updated in comments and metadata.

The controller documentation and page metadata have been properly updated to use "software catalog" instead of "app library", maintaining consistency with the rebranding effort. No functional changes, just terminology alignment.

Also applies to: 47-47

website/config/routes.js (3)

403-403: LGTM! Metadata description updated for consistency.

The page description has been properly updated to use "software catalog" terminology, maintaining consistency with the overall rebranding effort.


464-474: LGTM! Route paths correctly updated to new URL structure.

The route definitions have been properly updated from /app-library to /software-catalog while maintaining the same action mappings. The parameterized route for app details correctly preserves the :appIdentifier parameter structure.


726-731: Excellent implementation of backwards compatibility redirects.

The redirect implementation properly handles both the main app library route and the parameterized app details route. The redirect function correctly preserves the appIdentifier parameter when redirecting from /app-library/:appIdentifier to /software-catalog/:appIdentifier, ensuring existing bookmarks and links continue to work.

fleet-release
fleet-release previously approved these changes Jul 9, 2025
@eashaw
eashaw merged commit c7cbf09 into main Jul 9, 2025
7 checks passed
@eashaw
eashaw deleted the website-update-software-catalog-mentions branch July 9, 2025 22:02
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