Skip to content

Fixed broken links in docs #64

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

Merged
merged 1 commit into from
Jul 20, 2020
Merged

Fixed broken links in docs #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions docs/connectors/data_consumer_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,18 @@

## Understanding data types


The Code Climate Data Engineering Platform has a standard Data Schema,
representing 50+ common software development units, like epics, pull requests,
builds, incidents and more. Get a overview of the different data types
on the [Schema reference](docs/schemas/README.md).


## Invoking a connector on the CLI

For example, you're interested on using the CLI with the PagerDuty
connector. You can run the following commands to verify, discover
and sync:

```
```bash
# Verify
yarn run \
codeclimate-connector verify-configuration \
Expand Down
20 changes: 11 additions & 9 deletions docs/connectors/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,34 @@
# Getting Started

## Using a Connector
Follow the [Data Consumer’s Guide](docs/connectors/data_consumer_guide.md)

Follow the [Data Consumer’s Guide](./data_consumer_guide.md)
to learn how to use a Code Climate Connector. An easy-to-follow introduction
to understanding data types, running a connector through the CLI and following
the state of a connector.

## Concepts
Learn the [Concepts](docs/connectors/concepts.md) of Code Climate Connectors by

Learn the [Concepts](./concepts.md) of Code Climate Connectors by
reviewing its components and operations.

## Building a Connector

Learn how to integrate with a data source by following
a [Connector Developer’s Guide](docs/connectors/connector_developer_guide.md).
a [Connector Developer’s Guide](./connector_developer_guide.md).
This tutorial will cover a step-by-step guide on implementing the connector
and how to publish it.

## Reference

For a detailed overview of the Data Schema Connectors Specification,
check out the [Reference](docs/connecotrs/reference.md).
check out the [Reference](./reference.md).

## Reference implementations

- PagerDuty: https://github.com/codeclimate/codeclimate-connector-pagerduty
- CodeCov https://github.com/codeclimate/codeclimate-connector-codecov
- CircleCI https://github.com/codeclimate/codeclimate-connector-circleci
- [PagerDuty](https://github.com/codeclimate/codeclimate-connector-pagerduty)
- [CodeCov](https://github.com/codeclimate/codeclimate-connector-codecov)
- [CircleCI](https://github.com/codeclimate/codeclimate-connector-circleci)

## Community and Support

Expand All @@ -36,5 +38,5 @@ with the core team and contributing to the project:

* [Join the conversation on Slack](https://slack.codeclimate.com/) with
hundreds of community contributors
* Subscribe to our Developer Program mailing list (https://codeclimate.com/dev_form/)
to stay up-to-date
* Subscribe to our [Developer Program mailing list](https://codeclimate.com/dev_form/)
to stay up-to-date