Steps for getting a clean copy of the repository

[jericson-edb]

We're preparing to clean up some binary files from the docs repository which will substantially increase build actions. Unfortunately, this will require a few steps from everyone who has cloned or forked the repository.

Forked repositories

If you've used the GitHub website to edit EnterpriseDB/docs you probably have a fork of the repository. If so, you'll need to delete your repository using these instuctions. Once you are done, feel free to reclone the repository with clean history.

If you have any changes in your fork or a local repository of your fork, you'll need to follow these instructions:

Local repositories

Are you actively working on Docs and plan to push any changes in the future?

If no: If you have any local copies of the repository, please delete them so you don’t accidentally push changes to history. Congratulations! You are done!

Does your local repository have any changes that haven’t been pushed to GitHub?

If no: Please delete your local repository. In GitHub Desktop, just right click the docs repository and select “Remove…” If you want to check the box to move it to Trash, that’s fine but not necessary. Now reclone the repository. Once that’s done, you should be ready to make changes and push them to GitHub.

If yes: Go ahead and commit your changes but don’t push them! Then go to the terminal (GitHub Desktop shortcut: ^`) and type:

git format-patch -1

That will give you a patch file with a name something like:

0001-commit-message.patch

Save that file for later. It’s just a text file, so you can copy and paste its contents, if you like. While you are at it, take a look to make sure it captured all the changes you made. If you need help with this (or any other) step, contact me.

When you are ready, go ahead and delete your copy of the repository. (Maybe check the option to move it to Trash just in case we need to dig something out of it.) Then reclone the repository, checkout out the right branch, and go back into the terminal. Copy the patch file into the directory and run:

git apply 0001-commit-message.patch

(Obviously use the actual name of your patch!)

Once you are satisfied with your changes, delete the patch file then commit and push to GitHub. You finished!

Installing LFS

If you haven't done so already, you'll need to install LFS. GitHub Desktop will prompt you for this:

Or you can install LFS manually.

---

If you run into any problems at all, just contact me and I’ll help you through.

[jericson-edb]

Still useful, but I don't think this needs to be open anymore.