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

Remove the deprecated folder from the repository #1038

Open
5 tasks
cbrxyz opened this issue Apr 12, 2023 · 2 comments
Open
5 tasks

Remove the deprecated folder from the repository #1038

cbrxyz opened this issue Apr 12, 2023 · 2 comments
Labels
dev-tools difficulty: moderate documentation Improvements or additions to documentation software

Comments

@cbrxyz
Copy link
Member

cbrxyz commented Apr 12, 2023

Assignee

No response

Deadline

No response

What needs to change?

Our repository contains a deprecated folder for storing code that members want to keep around, but is no longer used. Rather than storing this code inside a deprecated folder, we should move this code into our documentation site, for several reasons:

  • Confusion amongst new members ("Why is there a deprecated folder?")
  • Needing to exclude search results from deprecated when attempting to find resources using tools like fd or grep
  • Moving the code into documentation can make it easier to find for new members and those not on a computer

This task requires going through the code listed in deprecated and moving the code into our documentation. This will require sifting through the code, determining what is important, and then putting that into a cute format for our documentation! :)

How would this task be tested?

  1. This task is simply code cleanup and documentation, so there shouldn't need to be any tests. Just ensure that nothing is broken by moving around different files and pieces of files!

Contacts

  • We need help from the mechanical team.
  • We need help from the electrical team.
  • We need help from Dr. Schwartz or other faculty.
  • We need help from a company or an organization.
  • We need help from another UF staff member or organization (ex, facilities).
@cbrxyz cbrxyz added documentation Improvements or additions to documentation dev-tools software difficulty: moderate labels Apr 12, 2023
@aaliao aaliao self-assigned this Apr 13, 2023
@MrinallU MrinallU assigned MrinallU and unassigned aaliao Aug 30, 2023
@MrinallU
Copy link
Contributor

MrinallU commented Sep 6, 2023

On second thought I'll probably come back to this once I have more experience.

@MrinallU MrinallU removed their assignment Sep 6, 2023
@kawaiiPlat
Copy link
Contributor

Checking if bot works

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev-tools difficulty: moderate documentation Improvements or additions to documentation software
Projects
None yet
Development

No branches or pull requests

4 participants