# Annalise AI - Confluence Junction
This project is expanded from (https://github.com/HUU/Junction)
# TO DO
- move away from using a docker image and use a pushlished python package
- unit tests for everything
# Running Locally
To run this locally run docker compose up with the documents and images directory as env vairables
```sh
DOCS=<path to docs> IMAGE=<path to images> docker-compose up
```
# Overview
Junction works by inspecting the changes made on a commit-by-commit basis to your Git repository, and determining what needs to be changed in Confluence to reflect those changes. Junction (currently) expects to manage the entire [space in Confluence](https://confluence.atlassian.com/doc/spaces-139459.html). Thus when using Junction you must tell it which Space to target and update. You must not manually change, create, or modify pages in the target space, or else Junction may be unable to synchronize the state in Git with the state in Confluence.
To allow mixing code (and other items) with markdown files for Junction in a single repository, you can tell Junction a subpath within your repository that functions as the root e.g. all markdown files will be kept in `docs/`. All files should end with the `.md` extension.
The page will gets its title from the file name, and its contents will be translated into Confluence markup. See [this example for what output looks like in Confluence](#output-example).
# Usage
Collect a set of credentials that Junction will use to login to Confluence. You will need to create an [API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) to use instead of a password. **I recommend you make a dedicated user account with access permissions limited to the space(s) you want to manage with Junction**.
In your git repository, create a folder structure and markdown files you would like to publish. Commit those changes.
``` bash
.
├── (your code and other files)
└── docs/
├── Welcome.md
├── Installation.md
└── Advanced Usage
| ├── Airflow.md
| ├── Visual Studio Online.md
| ├── Atlassian Bamboo.md
| └── GitHub Actions.md
└── Credits.md
```
## Images
Images should be placed inside the `images` directory within a subdirectory that has the same name as the respective file. for the above example the image directory could look like this.
```
.
└── images/
├── Welcome/
├── image1.png
└── image2.png
├── Installation/
└── image1.png
└── Advanced Usage/
├── image1.png
├── image2.png
├── Airflow/
└── image1.png
```
# Mermaid Diagrams
Mermaid diagrams can be included in the markdown but must include the document name in the opening fence:
` ```mermaid filename=<document name>`
see [here for using mermaid.js in github](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/)
Raw data
{
"_id": null,
"home_page": "https://github.com/HUU/Junction",
"name": "annalise-confluence-junction",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.0,<3.9.0",
"maintainer_email": "",
"keywords": "confluence,markdown,git,sync,convert",
"author": "Lachlan Newman",
"author_email": "lachnewman007@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/69/b8/5a1f64d8562e70fceee5ecd531d9549dc041e8ea93cf6a8165f520b0fb38/annalise_confluence_junction-2.0.0.tar.gz",
"platform": null,
"description": "\n# Annalise AI - Confluence Junction\n\nThis project is expanded from (https://github.com/HUU/Junction) \n\n# TO DO\n\n- move away from using a docker image and use a pushlished python package\n- unit tests for everything\n# Running Locally\n\nTo run this locally run docker compose up with the documents and images directory as env vairables\n```sh\nDOCS=<path to docs> IMAGE=<path to images> docker-compose up\n```\n\n# Overview\n\nJunction works by inspecting the changes made on a commit-by-commit basis to your Git repository, and determining what needs to be changed in Confluence to reflect those changes. Junction (currently) expects to manage the entire [space in Confluence](https://confluence.atlassian.com/doc/spaces-139459.html). Thus when using Junction you must tell it which Space to target and update. You must not manually change, create, or modify pages in the target space, or else Junction may be unable to synchronize the state in Git with the state in Confluence.\n\nTo allow mixing code (and other items) with markdown files for Junction in a single repository, you can tell Junction a subpath within your repository that functions as the root e.g. all markdown files will be kept in `docs/`. All files should end with the `.md` extension.\n\nThe page will gets its title from the file name, and its contents will be translated into Confluence markup. See [this example for what output looks like in Confluence](#output-example).\n\n# Usage\n\nCollect a set of credentials that Junction will use to login to Confluence. You will need to create an [API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) to use instead of a password. **I recommend you make a dedicated user account with access permissions limited to the space(s) you want to manage with Junction**.\n\nIn your git repository, create a folder structure and markdown files you would like to publish. Commit those changes.\n``` bash\n\n.\n\u251c\u2500\u2500 (your code and other files)\n\u2514\u2500\u2500 docs/\n \u251c\u2500\u2500 Welcome.md\n \u251c\u2500\u2500 Installation.md\n \u2514\u2500\u2500 Advanced Usage\n | \u251c\u2500\u2500 Airflow.md\n | \u251c\u2500\u2500 Visual Studio Online.md\n | \u251c\u2500\u2500 Atlassian Bamboo.md\n | \u2514\u2500\u2500 GitHub Actions.md\n \u2514\u2500\u2500 Credits.md\n```\n\n## Images\nImages should be placed inside the `images` directory within a subdirectory that has the same name as the respective file. for the above example the image directory could look like this.\n\n```\n.\n\u2514\u2500\u2500 images/\n \u251c\u2500\u2500 Welcome/\n \u251c\u2500\u2500 image1.png\n \u2514\u2500\u2500 image2.png\n \u251c\u2500\u2500 Installation/\n \u2514\u2500\u2500 image1.png\n \u2514\u2500\u2500 Advanced Usage/\n \u251c\u2500\u2500 image1.png\n \u251c\u2500\u2500 image2.png\n \u251c\u2500\u2500 Airflow/\n \u2514\u2500\u2500 image1.png\n```\n\n# Mermaid Diagrams\nMermaid diagrams can be included in the markdown but must include the document name in the opening fence:\n\n` ```mermaid filename=<document name>`\n\nsee [here for using mermaid.js in github](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/)",
"bugtrack_url": null,
"license": "MIT",
"summary": "Publish to and manage Confluence spaces with markdown files tracked in Git.",
"version": "2.0.0",
"split_keywords": [
"confluence",
"markdown",
"git",
"sync",
"convert"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "79386e9bf5ab1a8536e6f19511f675d0",
"sha256": "7c449e9e96e098ab300a30d92e88d6aea7c3c35c4a84d2aab4e0f22598c83763"
},
"downloads": -1,
"filename": "annalise_confluence_junction-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79386e9bf5ab1a8536e6f19511f675d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0,<3.9.0",
"size": 40827,
"upload_time": "2022-12-14T08:32:12",
"upload_time_iso_8601": "2022-12-14T08:32:12.503163Z",
"url": "https://files.pythonhosted.org/packages/44/f9/652fc247aacb5b0f621cb3f54b5e3d1497e3a2dcfceff067a8e4b3f9f720/annalise_confluence_junction-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "201966a661480d9209ab8c0b2704e196",
"sha256": "577c15f94cfb6cef6fbb084d287667d80ca9c215cb72c4733c56374a2a6036cb"
},
"downloads": -1,
"filename": "annalise_confluence_junction-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "201966a661480d9209ab8c0b2704e196",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0,<3.9.0",
"size": 46298,
"upload_time": "2022-12-14T08:32:13",
"upload_time_iso_8601": "2022-12-14T08:32:13.885680Z",
"url": "https://files.pythonhosted.org/packages/69/b8/5a1f64d8562e70fceee5ecd531d9549dc041e8ea93cf6a8165f520b0fb38/annalise_confluence_junction-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-14 08:32:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "HUU",
"github_project": "Junction",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "annalise-confluence-junction"
}
JSON
