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(.gitignore): remove dist of docs #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dorilahav
Copy link
Contributor

Remove docs/dist folder, no need for that on git.

@avivcarmis
Copy link
Contributor

@dorilahav this one is actually needed, it what serves this file needed for Chava's website.
Am i wrong? 🤔

@dorilahav
Copy link
Contributor Author

Pushing any kind of artifacts to git is a bad practice for a number of reasons:

  • You depend on someone remembering to build the project in order for it to get deployed properly.
  • You include in your build some parts of your node_modules which can take some good amount of your repository space when you get into large amounts of code.
  • Related to the previous reason, your artifacts will include some parts of your node modules which you don't entirely control, if at all which can cause a lot of conflicts when working with multiple branches (like what happened in this PR).

In order to prevent these problems, what people usually use is some sort of a CICD (I will be talking mostly about the CI part) which is in charge of building your code whenever you push your code (with your configured rules).
I would like to recommend a service called Vercel which can automatically detect pushes to your repository and deploy your website.

@avivcarmis
Copy link
Contributor

Just to make sure we're on the same page - are you familiar with GitHub Pages? If not, quickly read about it in general and this section specifically, in step 4 we've chosen /docs which means that this directory contains the actual website of ChavaScript. Including the artifacts needed to serve this website.
Do you suggest any way around it?

@dorilahav
Copy link
Contributor Author

You could use some other service like Vercel but if you use GitHub Pages you could also make it build your website instead of including the artifacts of your website on the repository. I would recommend using Vercel anyways as it takes care of everything for you automatically.

@avivcarmis
Copy link
Contributor

Hmm...I'll look into using GitHub actions to build artifacts (assuming this was your intention).
Anyways we wouldn't be able to merge this PR until i'm done so feel free to do whatever you can to help 🙏

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.

None yet

2 participants