Skip to content

Commit

Permalink
docs: Remove empty docs pages and fix broken links (NangoHQ#2372)
Browse files Browse the repository at this point in the history
## Describe your changes

## Issue ticket number and link

## Checklist before requesting a review (skip if just adding/editing
APIs & templates)
- [ ] I added tests, otherwise the reason is: 
- [ ] I added observability, otherwise the reason is:
- [ ] I added analytics, otherwise the reason is:
  • Loading branch information
bastienbeurier authored Jun 19, 2024
1 parent 88aacb4 commit 0aabb55
Show file tree
Hide file tree
Showing 18 changed files with 12 additions and 73 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For contributions, please [submit an issue](https://github.com/NangoHQ/nango/iss

# Contributing

You can run Nango locally with Docker ([step-by-step guide](https://docs.nango.dev/host/self-host/local)), contribute an API ([step-by-step guide](https://docs.nango.dev/customize/guides/contribute-an-api)) and contribute an integration template ([step-by-step guide](https://docs.nango.dev/contribute-an-integration-template)).
You can run Nango locally with Docker ([step-by-step guide](https://docs.nango.dev/host/self-host/local)) and contribute an API ([step-by-step guide](https://docs.nango.dev/customize/guides/contribute-an-api)).

## Develop locally

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ Sign up for free and try the interactive demo:

Our mission is to enable all SaaS to seamlessly integrate together. By being open source, every engineer can contribute improvements to the platform for everyone:
- [Contribute an API](/customize/guides/contribute-an-api)
- [Contribute integration templates](/customize/guides/contribute-an-integration-template)
- [Create a custom integration](/customize/guides/create-a-custom-integration)
- [Extend an integration template](/customize/guides/extend-an-integration-template)

# 📚 Learn more

Expand Down
9 changes: 0 additions & 9 deletions docs-v2/customize/guides/advanced/detect-deletions.mdx

This file was deleted.

This file was deleted.

9 changes: 0 additions & 9 deletions docs-v2/customize/guides/advanced/paginate-api-responses.mdx

This file was deleted.

This file was deleted.

9 changes: 0 additions & 9 deletions docs-v2/customize/guides/advanced/unify-apis-and-models.mdx

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ curl --request POST \
</Tab>
</Tabs>

The sync's internal logic will use the field mappings to fetch the relevant data from custom fields ([step-by-step guide](/customize/guides/advanced/support-custom-field-mappings)).
The sync's internal logic will use the field mappings to fetch the relevant data from custom fields.

<Tip>
**Questions, problems, feedback?** Please reach out in the [Slack community](https://nango.dev/slack).
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/integrations/all/checkr-partner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ API configurations: [`checkr-partner`](https://nango.dev/providers.yaml), [`chec

const response = await nango.get(config);
```
- You can have a look at the following simple [sync template](/integrations/integration-templates/checkr-partner-staging) based on [Checkr retrieve authenticated account details](https://docs.checkr.com/#tag/Account)
- You can have a look at the following simple [sync template](/integrations/integration-templates/checkr-partner) based on [Checkr retrieve authenticated account details](https://docs.checkr.com/#tag/Account)

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/checkr-partner.mdx)</Note>
2 changes: 1 addition & 1 deletion docs-v2/integrations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@ Nango is pre-configured for 190+ APIs and integration templates.
Missing an API or integration template?

- request it in the [community](https://nango.dev/slack); we deliver them in &lt;48h
- contribute it; it's fast & easy ([new API](/customize/guides/contribute-an-integration-template) / [new integration template](/customize/guides/contribute-an-integration-template))
- contribute it; it's fast & easy ([new API](/customize/guides/contribute-an-api))
3 changes: 2 additions & 1 deletion docs-v2/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ Sign up for free and try the interactive demo:

Our mission is to enable all SaaS to seamlessly integrate together. By being open source, every engineer can contribute improvements to the platform for everyone:
- [Contribute an API](/customize/guides/contribute-an-api)
- [Contribute integration templates](/customize/guides/contribute-an-integration-template)
- [Create a custom integration](/customize/guides/create-a-custom-integration)
- [Extend an integration template](/customize/guides/extend-an-integration-template)

# 📚 Learn more

Expand Down
6 changes: 0 additions & 6 deletions docs-v2/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -168,12 +168,6 @@
"group": "Advanced",
"pages": [
"customize/guides/advanced/handle-rate-limits",
"customize/guides/advanced/support-custom-field-mappings",
"customize/guides/advanced/detect-deletions",
"customize/guides/advanced/paginate-api-responses",
"customize/guides/advanced/use-environment-variables",
"customize/guides/advanced/unify-apis-and-models",
"customize/guides/advanced/handle-errors-in-scripts",
"customize/guides/advanced/handle-large-datasets",
"customize/guides/advanced/migrate-integration-configuration"
]
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/reference/scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ await nango.triggerAction('<ACTION-NAME>', { 'custom_key1': 'custom_value1' });

# Paginate through API responses

Follow the pagination [step-by-step guides](/customize/guides/advanced/paginate-api-responses) to learn how to paginate through API responses easily.
_TbD_

# Manage connection metadata

Expand Down
2 changes: 1 addition & 1 deletion docs-v2/understand/concepts/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The outcomes of action executions, whether errors or successes, are directly rel

### Unified modeling

Actions support inputs and outputs that adhere to [unified models](/customize/guides/advanced/unify-apis-and-models), streamlining the integration process across different external APIs.
Actions support inputs and outputs that adhere to unified models, streamlining the integration process across different external APIs.

**Action vs. the proxy**

Expand Down
2 changes: 1 addition & 1 deletion docs-v2/understand/concepts/proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Nango's Proxy simplifies making authenticated requests to external APIs. It’s

- **Automatic Credential Injection:** Automatically adds necessary authentication to your API requests.
- **Base URL Setup:** Automatically determines and sets the correct base URL for your API requests.
- **Effortless Pagination:** Simplifies dealing with API pagination ([step-by-step guide](/customize/guides/advanced/paginate-api-responses)).
- **Effortless Pagination:** Simplifies dealing with API pagination.
- **Logs for Debugging:** Tracks your requests in the Activity tab for easy debugging.
- **Rate-limit Management:** Handles rate limits with smart retries ([step-by-step guide](/customize/guides/advanced/handle-rate-limits)).

Expand Down
2 changes: 1 addition & 1 deletion docs-v2/understand/concepts/syncs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Unlike actions, the syncs default function doesn't take any input parameters or

# API unification

Syncs can have records that conform to a [unified model](/customize/guides/advanced/unify-apis-and-models), regardless of the specific external API they originate from. This unification simplifies your integration code, enabling you to handle data from various sources in a consistent manner, thus reducing complexity and the potential for errors.
Syncs can have records that conform to a unified model, regardless of the specific external API they originate from. This unification simplifies your integration code, enabling you to handle data from various sources in a consistent manner, thus reducing complexity and the potential for errors.

# Getting started with syncs

Expand Down
3 changes: 0 additions & 3 deletions docs-v2/understand/concepts/templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,6 @@ While contributing your custom integration as templates with the community is op
### Learning from Templates
Templates are invaluable for learning about integration best practices, including handling pagination, rate limits, data mappings, etc. They serve as practical examples of how to build efficient and scalable integrations.

### Contributing to the Community
If you're interested in contributing a template, refer to our [contribution guide](/customize/guides/contribute-an-integration-template).

# Template Updates

Currently, templates do not update automatically; they remain at the version you activate. This ensures your integration remains stable over time, without unexpected changes from template updates.
Expand Down

0 comments on commit 0aabb55

Please sign in to comment.