Skip to content

[internal docs ]adding readme.io manual sync instructions #304

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[internal docs ]adding readme.io manual sync instructions #304

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3786d2e
[internal docs ]adding readme.io manual sync instructions
fscelliott Apr 19, 2021
b3e7c5c
docs - fixing broken links (#305)
fscelliott Apr 21, 2021
06bb365
[internal docs ]adding readme.io manual sync instructions
fscelliott Apr 19, 2021
cd610d5
Merge branch 'fscelliott-patch-1' of github.com:optimizely/agent into…
fscelliott Apr 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
## Internal docs authoring notes


### deploying to readme.io

When you edit the docs in /docs/readme-sync/ and merge to the master branch, you trigger a Travis build stage (readme-sync) that syncs the Markdown doc files to FullStack public docs at https://docs.developers.optimizely.com/full-stack/docs/optimizely-agent.

If for any reason the travis build isn't working, you can publish the docs from GitHub to readme.io manually. For the sync tool's readme see [https://github.com/flowcommerce/readme-sync](https://github.com/flowcommerce/readme-sync). Here are quick instructions:
1. clone https://github.com/flowcommerce/readme-sync to an environment in which you've installed Node & NPX.
2. clone this agent repo
3. Record the API key for the the full stack docs project (https://dash.readme.com/project/full-stack/v4.0/api-key)
4. From the readme-sync cloned directory, run the sync for the docs version you want using the API key and the local directory path to the docs, i.e:
`npx ts-node sync/index.ts --apiKey <your_api_key_here> --version 4.0 --docs ~/Github/agent/docs/readme-sync/v4.0`
and
`npx ts-node sync/index.ts --apiKey <your_api_key_here> --version 3.1 --docs ~/Github/agent/docs/readme-sync/v3.1`

### Previewing

Before you commit to master, there's a travis stage that syncs your branch's changes to a ReadMe sandbox so you can preview the published output, https://docs.developers.optimizely.com/full-stack/docs/ (you need to be logged into ReadMe to see this sandbox, since it's not public).
Expand Down