groot/automatisch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add how to create github connection guide

Browse Source
This commit is contained in:
Faruk AYDIN
2022-07-20 13:05:19 +03:00
parent 69298857a9
commit 311f0a747d
2 changed files with 12 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/backend/src/apps/github/info.json
View File

@@ -19,26 +19,26 @@
}, },
{ {
"key": "consumerKey", "key": "consumerKey",
"label": "Consumer Key", "label": "Client ID",
"type": "string", "type": "string",
"required": true, "required": true,
"readOnly": false, "readOnly": false,
"value": null, "value": null,
"placeholder": null, "placeholder": null,
"description": null, "description": null,
"docUrl": "https://automatisch.io/docs/github#consumer-key", "docUrl": "https://automatisch.io/docs/github#client-id",
"clickToCopy": false "clickToCopy": false
}, },
{ {
"key": "consumerSecret", "key": "consumerSecret",
"label": "Consumer Secret", "label": "Client Secret",
"type": "string", "type": "string",
"required": true, "required": true,
"readOnly": false, "readOnly": false,
"value": null, "value": null,
"placeholder": null, "placeholder": null,
"description": null, "description": null,
"docUrl": "https://automatisch.io/docs/github#consumer-secret", "docUrl": "https://automatisch.io/docs/github#client-secret",
"clickToCopy": false "clickToCopy": false
} }
], ],

90
packages/docs/docs/connections/github.md
View File

@@ -4,85 +4,11 @@ sidebar_position: 1
# Github # Github
Let's translate `docs/intro.md` to French. 1. Go to the [link](https://github.com/settings/applications/new) to register a **new OAuth application** on Github.
2. Fill **Application name** and **Homepage URL**.
## Configure i18n 3. Copy **OAuth Redirect URL** from Automatisch to **Authorization callback URL** field on Github page.
4. Click on the **Register application** button on the Github page.
Modify `docusaurus.config.js` to add support for the `fr` locale: 5. Copy the **Client ID** value from the following page to the `Client ID` field on Automatisch.
6. Click **Generate a new client secret** on the Github page and copy generated value into the `Client Secret` field on Automatisch.
```js title="docusaurus.config.js" 7. Click **Submit** button on Automatisch.
module.exports = { 8. Congrats! Start using your new Github connection within the flows.
i18n: {
defaultLocale: 'en',
locales: ['en', 'fr'],
},
};
```
## Translate a doc
Copy the `docs/intro.md` file to the `i18n/fr` folder:
```bash
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
```
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
## Start your localized site
Start your site on the French locale:
```bash
npm run start -- --locale fr
```
Your localized site is accessible at `http://localhost:3000/fr/` and the `Getting Started` page is translated.
:::caution
In development, you can only use one locale at a same time.
:::
## Add a Locale Dropdown
To navigate seamlessly across languages, add a locale dropdown.
Modify the `docusaurus.config.js` file:
```js title="docusaurus.config.js"
module.exports = {
themeConfig: {
navbar: {
items: [
// highlight-start
{
type: 'localeDropdown',
},
// highlight-end
],
},
},
};
```
The locale dropdown now appears in your navbar:
![Locale Dropdown](/img/tutorial/localeDropdown.png)
## Build your localized site
Build your site for a specific locale:
```bash
npm run build -- --locale fr
```
Or build your site to include all the locales at once:
```bash
npm run build
```