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(classic): update docs for security deprecation #8632

Conversation

ntindle
Copy link
Member

@ntindle ntindle commented Nov 12, 2024

We need to clearly state that the classic AutoGPT is unsupported for security reasons.

Changes 🏗️

Adds a readme for classic autogpt to show that we won't update

Checklist 📋

For code changes:

  • I have clearly listed my changes in the PR description
  • I have made a test plan
  • I have tested my changes according to the test plan:
    • Test Plan
Test Plan
  • Open the classic readme and make sure it renders
  • Test the links
  • Check the docs page for classic has the warning

@ntindle ntindle requested a review from a team as a code owner November 12, 2024 22:34
@ntindle ntindle requested review from Swiftyos and Pwuts and removed request for a team November 12, 2024 22:34
Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Broken Link
The documentation link on line 57 contains a space between the text and URL which breaks the markdown link formatting

Navigation Issue
The getting started instructions tell users to cd into 'classic' directory but this may not exist since the clone command gets the whole repo

Copy link

netlify bot commented Nov 12, 2024

Deploy Preview for auto-gpt-docs canceled.

Name Link
🔨 Latest commit 7420bd7
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/6734f4efdf344c00085bb3ba

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 12, 2024
@ntindle
Copy link
Member Author

ntindle commented Nov 12, 2024

nodejs/node#55829 related to failure

@ntindle ntindle changed the title Create README.md fix(classic): update docs for security deprecation Nov 12, 2024
Copy link
Contributor

@kbarnard10 kbarnard10 left a comment

Choose a reason for hiding this comment

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

Suggesting to replace mentions of "AutoGPT" with "AutoGPT Classic" when referring to the original implementation to avoid confusion with the current state of the project (platform and self-hosted), which is actively supported.

docs/content/classic/index.md Outdated Show resolved Hide resolved
docs/content/classic/index.md Outdated Show resolved Hide resolved
classic/README.md Outdated Show resolved Hide resolved
classic/README.md Outdated Show resolved Hide resolved
classic/README.md Outdated Show resolved Hide resolved
classic/README.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added size/l and removed size/m labels Nov 13, 2024
@ntindle ntindle requested a review from kbarnard10 November 13, 2024 17:39
@itsababseh itsababseh assigned itsababseh and unassigned itsababseh Nov 13, 2024
@itsababseh itsababseh requested review from itsababseh and removed request for kbarnard10 November 13, 2024 18:44
Copy link

@itsababseh itsababseh left a comment

Choose a reason for hiding this comment

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

This looks good to me and is more clear with AutoGPT Classic!

@ntindle ntindle enabled auto-merge (squash) November 13, 2024 18:50
@ntindle ntindle merged commit b048385 into dev Nov 13, 2024
13 checks passed
@ntindle ntindle deleted the ntindle/secrt-992-post-a-clear-not-supported-message-in-the-classic-folder branch November 13, 2024 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation platform/backend AutoGPT Platform - Back end Review effort [1-5]: 1 size/l
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants