Update docs#66
Draft
nellshamrell wants to merge 2 commits into
Draft
Conversation
Signed-off-by: Nell Shamrell <nellshamrell@gmail.com>
Signed-off-by: Nell Shamrell <nellshamrell@gmail.com>
Collaborator
liquidsteves
left a comment
liquidsteves
left a comment
There was a problem hiding this comment.
Woot! Very glad you are doing this. Thanks so much for diving in.
| a. Go to the [Google API Console](https://console.developers.google.com/apis/credentials) | ||
| b. Create a project, if you have not already | ||
| c. Go to `Create Credentials --> OAuth client ID` | ||
| c. Go to `Create Credentials --> OAuth client ID` (TODO: What Application Type should you choose?) |
Collaborator
There was a problem hiding this comment.
Matt is looking into that.
Comment on lines
-36
to
+47
| - Setup Secrets by looking at the following templates and re-creating them: | ||
| - `git_key.template` -> `git_key` | ||
| - `IngestionGoogleKey.json.template` -> `IngestionGoogleKey.json` | ||
| - `TranslationGoogleKey.json.template` -> `TranslationGoogleKey.json` | ||
|
|
||
| **Set up secrets files** | ||
|
|
||
| ```bash | ||
| cp secrets/git_key_template git_key | ||
| cp secrets/IngestionGoogleKey.json.template IngestionGoogleKey.json | ||
| cp TranslationGoogleKey.json.template TranslationGoogleKey.json | ||
| ``` |
Collaborator
There was a problem hiding this comment.
Can you clarify that the person needs to read over the files and edit them as appropriate, not just copy them?
Comment on lines
+33
to
+34
| git clone git@github.com:nyc-cto/tms.git | ||
| cd tms |
Comment on lines
+47
to
+72
| Now that you have the Google Drive folder structure for translations, let's try running one. | ||
|
|
||
| In your Translations/en folder, create a new doc called "translation1". | ||
|
|
||
| In the doc, add this text: | ||
|
|
||
| ``` | ||
| Hello, world! | ||
| ``` | ||
|
|
||
| Next, head to your command line on your local workstation and enter your running Docker container (if you are using Docker to run the service): | ||
|
|
||
| ```bash | ||
| (your-local-workstation) $ docker-compose exec serge bash | ||
| ``` | ||
|
|
||
| Once you are in the container, change to this directory: | ||
|
|
||
| ```bash | ||
| (docker-container) $ cd /var/tms | ||
| ``` | ||
|
|
||
| And run this command: | ||
|
|
||
| ```bash | ||
| (docker-container) $ sh run_ingest_sync_simple.sh |
Collaborator
There was a problem hiding this comment.
Good idea to add an example of running it
Collaborator
|
@nellshamrell thanks for adding the examples and steps! I added some clarifying steps for the import/export setup as described in the email chain here: #67. @liquidsteves once this PR is merged in, I'll merge mine in after review. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This is still a work in progress