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

docs links updated #328

Merged
merged 3 commits into from
Sep 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- What were you trying to accomplish when you ran into the issue?
- What did you expect to happen?
- What happened instead?
- Please provide [debugging information](https://docs.useoptic.com/debugging-diffs).
- Please provide [debugging information](https://www.useoptic.com/docs/faqs-and-troubleshooting/debugging).
- It's possible your report is not part of the designed scope. It may be closed as such. If so, feel free to consider submitting a **Feature Request**.
- **Feature Requests** cover all requests for additional behavior and requests for changes in designed scope. If the software is not working as intended, that's an **Issue** which needs to be reported.
- All feature requests must be filed through [GitHub Issues](https://github.com/opticdev/optic/issues).
Expand Down
12 changes: 6 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ yarn add global @useoptic/cli
api init
```

![The api start command initializing](https://docs.useoptic.com/assets/images/init.svg)
![The api start command initializing](https://www.useoptic.com/static/init-9a9c43677e29e2b6f9f04bd7ce81ec26.svg)

Then, add your start command to the `optic.yml` file created by `api init`. This allows Optic to start your project and observe its request traffic.

Expand All @@ -50,7 +50,7 @@ tasks:
baseUrl: http://localhost:4000
```

For further information, please visit the full [installation instructions](https://docs.useoptic.com/install).
For further information, please check out our [setup instructions](https://app.useoptic.com/).

### Use the Optic Proxy to Monitor your API's Behavior

Expand All @@ -63,7 +63,7 @@ api start

Optic will start your application, and observe API requests run against it. Optic manages these observations in a capture session. When Optic observes traffic that it hasn't yet seen, or that has changed from previous observations, it will list it with examples of payloads in the Optic Dashboard for the capture session. As you make changes to your code, such as adding or updating API endpoints, Optic will establish new capture sessions for each build and report back on observed behavior.

Our detailed [setup instructions](https://docs.useoptic.com/setup) will get you started with additional context for several popular languages and frameworks.
Our detailed [setup instructions](https://app.useoptic.com/) will get you started with additional context for several popular languages and frameworks.

### Use Optic to Manage your API Specification

Expand All @@ -80,7 +80,7 @@ As you committ the observed diffs, Optic builds documentation in OpenAPI format

### See it for Yourself

The best way to see Optic in action is to get [set up](https://docs.useoptic.com/setup) in your current API project. You can also try our [interactive demo](https://docs.useoptic.com/demo) to get a highlight of Optic's workflow and capabilities.
The best way to see Optic in action is to get [set up](https://app.useoptic.com/) in your current API project. You can also try our [interactive demo](https://demo.useoptic.com) to get a highlight of Optic's workflow and capabilities.

## Key Features
📝 **Accurate API Documentation** - We built Optic to make maintaining accurate specs for your APIs automatic and developer friendly. Once you add Optic to your API repo, it automatically tracks your API’s behavior and maintains a change log of its behavior over time.
Expand All @@ -94,9 +94,9 @@ It’s kind of like Git, but instead of tracking files, Optic automatically diff
👋 **100% Open Source, Runs locally, data is only stored in your API Repo**


## Documentation [https://docs.useoptic.com](https://docs.useoptic.com)
## Documentation [https://useoptic.com/docs](https://www.useoptic.com/docs)

- Read the full docs at: [docs.useoptic.com](https://docs.useoptic.com).
- Read the full docs at: [useoptic.com/docs](https://www.useoptic.com/docs).
- Want to contribute? Check out the [Contribution Guidelines](Contributing.md).
- To get set up working on the project, please review our [Developer Setup](Developer-setup.md) guide as well.

Expand Down
2 changes: 1 addition & 1 deletion workspaces/cli-shared/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export async function loadPathsAndConfig(cli: Command) {
cli.log(
fromOptic(
`No Optic project found in this directory. Learn to add Optic to your project here ${colors.underline(
'https://docs.useoptic.com/setup'
'https://app.useoptic.com'
)}`
)
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default class TestNotification extends Command {
console.log({ basePath, notifyScriptPath });
runStandaloneScript(
notifyScriptPath,
'https://docs.useoptic.com',
'https://www.useoptic.com/docs',
iconPath
);
}
Expand Down
13 changes: 8 additions & 5 deletions workspaces/local-cli/src/commands/init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,15 @@ export default class Init extends Command {
const config = `
name: ${name}
tasks:
# The default task, invoke using \`api run taskname\`
# Learn how to finish setting up Optic at https://useoptic.com/docs/getting-started/setup/
${buildInitialTask(flags)}

# The default task, invoke using \`api run start\`
# Learn how to set up and use Optic at https://app.useoptic.com
start:
command: ${
flags.command || 'echo "Setup A Valid Command to Start your API!"'
}
inboundUrl: ${flags.inboundUrl || 'http://localhost:4000'}
ignoreRequests:
# For more information on configuration, visit https://useoptic.com/docs/faqs-and-troubleshooting/captures
# For more information on configuration, visit https://www.useoptic.com/docs/faqs-and-troubleshooting/captures
- OPTIONS (.*)`.trimLeft();

// const token: string = await Promise.resolve('token-from-backend')
Expand Down
2 changes: 2 additions & 0 deletions workspaces/local-cli/src/shared/verify/verify.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ export async function verifyTask(
let foundTask: IOpticTaskAliased | null = null;
let startConfig: IOpticTaskRunnerConfig | null = null;

let fixUrl = 'https://www.useoptic.com/docs/faqs-and-troubleshooting/';

await niceTry(async () => {
if (config.tasks) {
const task = config.tasks[taskName];
Expand Down
2 changes: 1 addition & 1 deletion workspaces/ui/src/components/support/Links.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const docsBaseLink = 'https://docs.useoptic.com';
const docsBaseLink = 'https://www.useoptic.com/docs/';

export const OpticDocs = docsBaseLink + '/';
export const AddOpticLink = docsBaseLink + '/setup';
Expand Down