Skip to content

Remove references to projects in docs site#467

Merged
validbeck merged 9 commits intomainfrom
beck/sc-6401/remove-references-to-projects-in-documentation
Oct 9, 2024
Merged

Remove references to projects in docs site#467
validbeck merged 9 commits intomainfrom
beck/sc-6401/remove-references-to-projects-in-documentation

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Oct 8, 2024

Internal Notes for Reviewers

sc-6401

What's left

  • References to Google Private Service Connect projects
  • OLD references to projects in releases prior to the first time we removed projects from the UI

Other adjustments

  • Added the .screenshot class to the recent backfilled Generate with AI release notes as this was missed in the audit due to being an adjacent PR
Screenshot 2024-10-08 at 10 21 45 AM
  • Edited the View model activity & Review model documentation docs to reflect minor changes in the UI
View model activity Review model documentation
Screenshot 2024-10-08 at 10 22 00 AM Screenshot 2024-10-08 at 10 22 13 AM

@validbeck validbeck added the internal Not to be externalized in the release notes label Oct 8, 2024
@validbeck validbeck self-assigned this Oct 8, 2024
@validbeck validbeck requested a review from nrichers October 8, 2024 16:36
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 8, 2024

PR Summary

This pull request refactors the documentation across multiple files to replace the term 'project' with 'model'. This change is applied to various sections, including documentation guides, code snippets, and configuration instructions. The update aims to align the terminology with the current focus on model-centric documentation and risk management processes. Key changes include:

  • Replacing 'project identifier' with 'model identifier' in configuration and initialization examples.
  • Updating documentation titles and content to reflect the shift from 'project' to 'model'.
  • Modifying code snippets in Jupyter notebooks to use 'model' instead of 'project'.
  • Adjusting documentation and test descriptions to focus on model-related tasks and processes.

These changes ensure consistency in terminology across the documentation and code examples, enhancing clarity for users working with model documentation and risk management.

Test Suggestions

  • Verify that all instances of 'project' have been correctly replaced with 'model' in the documentation files.
  • Check that code snippets in Jupyter notebooks execute without errors after the terminology update.
  • Ensure that all links and references to documentation sections are still valid and correctly point to the updated content.
  • Test the initialization process using the updated 'model' identifier in configuration files and code snippets.
  • Review the generated documentation to confirm that the terminology change is reflected in all relevant sections.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 8, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 8, 2024

A PR preview is available: Preview URL

Copy link
Copy Markdown
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM! My apologies for the delay in reviewing. :shipit:

@validbeck validbeck merged commit 3173b0c into main Oct 9, 2024
@validbeck validbeck deleted the beck/sc-6401/remove-references-to-projects-in-documentation branch October 9, 2024 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants