Update documentation README for gh-pages branch #619
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
taylorfturner
added
Bug
JGSweets
reviewed
Aug 23, 2022
README.md
Outdated
| update the documentation (probably main). | ||
| 1. Either with an existing clone of `capitalone/dataprofiler` or clone the `capitalone/dataprofiler` reposotory to your local computer with the following command: | ||
| ```bash | ||
| git clone https://github.com/capitalone/DataProfiler dataprofiler |
There was a problem hiding this comment.
Do we need to enforce downloading it with that name?
There was a problem hiding this comment.
don't have to
There was a problem hiding this comment.
Let's not enforce it. In the case someone sets up a second repo, this could cause conflicts.
There was a problem hiding this comment.
gotcha so will default to DataProfiler ... could be the same issue with conflicts, but most folks should have a capitalone/dataprofiler clone already so this clone command shouldn't need to happen for most folks on our team
JGSweets
reviewed
Aug 23, 2022
JGSweets
suggested changes
Aug 23, 2022
JGSweets
reviewed
Aug 23, 2022
JGSweets
approved these changes
Aug 23, 2022
JGSweets
pushed a commit
that referenced
this pull request
Oct 5, 2022
* update README steps * update README directions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bullet point out the exact steps for re-generating gh pages for Data Profiler (w/ context for exactly from where the commands should be run)