Skip to content

Commit 8086085

Browse files
committed
docs: Change confluence-tools repo url
1 parent fedc497 commit 8086085

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

.github/workflows/contributor-license-agreement.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
path-to-signatures: 'signatures/version1/cla.json'
3333
create-file-commit-message: 'Creating file for storing CLA Signatures'
3434
signed-commit-message: '$contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
35-
path-to-document: 'https://github.com/Telefonica/cross-confluence-tools/blob/master/.github/CLA.md'
35+
path-to-document: 'https://github.com/Telefonica/markdown-confluence-sync-action/blob/master/.github/CLA.md'
3636
branch: 'cla-signatures'
3737
# the below is the list of users who are allowed to sign the CLA without any check
3838
allowlist: renovate,renovate[bot]

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Markdown Confluence Sync action
44

5-
This action syncs markdown files to Confluence using the [Markdown Confluence Sync](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync) library.
5+
This action syncs markdown files to Confluence using the [Markdown Confluence Sync](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync) library.
66

77
## Table of contents
88

@@ -33,7 +33,7 @@ This action syncs markdown files to Confluence using the [Markdown Confluence Sy
3333
* **flat**: Synchronize a list of markdown files matched by a [glob pattern](https://github.com/isaacs/node-glob#glob-primer) as children page of a Confluence root page, without any hierarchy. It is also possible to provide a Confluence id to some pages to update them directly, as in the id mode.
3434

3535
> [!NOTE]
36-
> Read the [Markdown Confluence Sync library documentation](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync) for detailed information about all features and configuration options.
36+
> Read the [Markdown Confluence Sync library documentation](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync) for detailed information about all features and configuration options.
3737
3838
## Usage
3939

@@ -76,7 +76,7 @@ docs/
7676
```
7777
7878
> [!TIP]
79-
> Read the [tree mode docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#tree-mode) for further information about configuration options and how to organize your markdown files.
79+
> Read the [tree mode docs](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync#tree-mode) for further information about configuration options and how to organize your markdown files.
8080
8181
### Id operation mode
8282
@@ -179,7 +179,7 @@ The action accepts a configuration file in the root of the repository, and it ca
179179
|------|-------------|----------|---------|
180180
| `mode` | Operation mode: `tree`, `id` or `flat` | No | `tree` |
181181
| `docs-dir` | Path to the directory containing the markdown files | __Yes__ | |
182-
| `files-metadata` | Array of objects with the metadata of the files to sync, expressed as an stringified JSON (supports multiline). Each object must have at least the `path` property for identifying the file. For the rest of properties read the [markdown-confluence-sync docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#filesmetadata-property) | No | |
182+
| `files-metadata` | Array of objects with the metadata of the files to sync, expressed as an stringified JSON (supports multiline). Each object must have at least the `path` property for identifying the file. For the rest of properties read the [markdown-confluence-sync docs](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync#filesmetadata-property) | No | |
183183
| `files-pattern` | Pattern to filter the files to sync in flat or id mode | No | |
184184
| `ignore`| Semicolon separated list of [glob](https://github.com/cowboy/node-globule) patterns to ignore files. Matches are based on the current working directory | No | |
185185
| `confluence-url` | Confluence base URL | __Yes__ | |
@@ -194,7 +194,7 @@ The action accepts a configuration file in the root of the repository, and it ca
194194
| `cwd` | Current working directory. Path from where resolve `docs-dir`, `files-pattern`, `ignore`, and search for the configuration file. It must be relative to the repository folder | No | Repository root (`.`) |
195195

196196
> [!NOTE]
197-
> Some markdown-confluence-sync options are not available as inputs in the action, as `preprocessor`. If you need to use them, you can set them in the [configuration file](#configuration-file) or using [environment variables](#environment-variables). Refer to the [Markdown Confluence Sync library docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#configuration-file) for further info about all available options.
197+
> Some markdown-confluence-sync options are not available as inputs in the action, as `preprocessor`. If you need to use them, you can set them in the [configuration file](#configuration-file) or using [environment variables](#environment-variables). Refer to the [Markdown Confluence Sync library docs](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync#configuration-file) for further info about all available options.
198198
199199
### Configuration file
200200

@@ -219,13 +219,13 @@ module.exports = {
219219
```
220220

221221
> [!NOTE]
222-
> Read the [Markdown Confluence Sync library docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#configuration-file) for further info about the configuration file.
222+
> Read the [Markdown Confluence Sync library docs](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync#configuration-file) for further info about the configuration file.
223223
224224
### Environment variables
225225

226226
The action can be configured using environment variables. The environment variables must be prefixed with `MARKDOWN_CONFLUENCE_SYNC_` and use uppercase letters.
227227

228-
Read the [Markdown Confluence Sync library docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#environment-variables) for further info about environment variables.
228+
Read the [Markdown Confluence Sync library docs](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync#environment-variables) for further info about environment variables.
229229

230230
## Contributing
231231

0 commit comments

Comments
 (0)