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

Rename scripts directory to ci #37

Merged
merged 1 commit into from
Jan 12, 2024
Merged

Rename scripts directory to ci #37

merged 1 commit into from
Jan 12, 2024

Conversation

prrao87
Copy link
Member

@prrao87 prrao87 commented Jan 12, 2024

@sanders41 the directory name scripts in the root level of the repo is a bit misleading and can cause folks to think it's necessary to use in the pieces directory (which actually has the code). I've renamed it to ci to be more explicit so that visitors who are checking out the repo don't mistakenly click on it thinking there's useful code in there.

Could you verify that there's nothing that's broken as a result of this name change? I suppose the CI itself will tell us something.

@prrao87
Copy link
Member Author

prrao87 commented Jan 12, 2024

Alternately, if the ci directory isn't required for any other purpose (which it shouldn't), does it make sense to move it to the .github directory and update the paths accordingly? The root level would ideally have just the pieces and the book sections to make it clear what's where to a new visitor.

I'll also be looking into the mdBook CI best practices for styling on the book, so that'll go into the .github/workflows as a separate action as well.

Copy link
Collaborator

@sanders41 sanders41 left a comment

Choose a reason for hiding this comment

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

Everything looks good here. I didn't really like the name scripts since it has things like docker-compose files also.

@prrao87
Copy link
Member Author

prrao87 commented Jan 12, 2024

Alright, let me merge this and we can see later on about how it looks once the book's CI goes in.

@prrao87 prrao87 merged commit 727dd3b into main Jan 12, 2024
4 checks passed
@prrao87 prrao87 deleted the path-fix branch January 12, 2024 19:18
@sanders41
Copy link
Collaborator

Alternately, if the ci directory isn't required for any other purpose (which it shouldn't), does it make sense to move it to the .github directory and update the paths accordingly? The root level would ideally have just the pieces and the book sections to make it clear what's where to a new visitor.

This is a good question. I wasn't sure if putting it in the .github directory would cause any issues since it is a special directory. We could try it and see what happens. It should be quickly apparent if it works.

@prrao87
Copy link
Member Author

prrao87 commented Jan 12, 2024

Will give this a try once I push the book PR 👍🏽

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