Skip to content
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.

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

support linked documents #19

Closed
f3rdy opened this issue Jun 19, 2020 · 4 comments
Closed

support linked documents #19

f3rdy opened this issue Jun 19, 2020 · 4 comments
Labels
enhancement New feature or request help wanted Extra attention is needed v4

Comments

@f3rdy
Copy link

f3rdy commented Jun 19, 2020

Hi, thanks for the tool. At a first glance it looks promising and helpful.

I've got a structure like this in my project:

project_root/readme.md
project_root/documentation/do_this.md
project_root/documentation/do_that.md

I use the readme.md moreover to link to the subdocuments and use it primarily as an index or TOC file. From the subdocuments, I link back to the index or to other subdocuments.

First problem I encounter is, that the the links between the project root directory and subdirectories are not translated into confluence pages/subpages and therefore do not work.

I think, I could flatten the structure to put the readme.md into the documentation subdirectory of the source code and just use the project root readme.md to link to the documentation/readme.md. That might do it.

A different case would be to have links to (other) source code files in my markdown. It would be cool to have a possibility to change relative links to local files at least by absolute links to the current repository. Sure, I can do that directly in the markdown, but wouldn't it be better to have this in the tooling?

Thanks,
ferdy

@justmiles
Copy link
Owner

Hey @f3rdy. I like the idea and agree it would certainly be useful, but I'm not really sure how to implement it. The API doesn't have an ID for the confluence document until after it is created. You could probably look at each document and map dependencies so that each document knows the actual confluence link it needs to point to before rendering - but what if you have two documents that link to one-another. Then again, we could map all the dependencies, upload, then edit and re-upload anything linking.

Initial thoughts are that it's a sizable chunk of work for the value. Definitely happy to merge pull requests that solve for it but this doesn't seem like something I can tackle right now. I'll leave this open in the hopes that someone else has the motivation to take it on. Thanks for opening the ticket!

@justmiles justmiles added help wanted Extra attention is needed enhancement New feature or request labels Jul 22, 2020
@Skeeve
Copy link
Contributor

Skeeve commented Oct 1, 2020

Are Document IDs really required?

When I created 2 testpages, the link generated in the page looks like this:

<ac:link><ri:page ri:content-title="TestPage2" /></ac:link>

@mschmieder
Copy link

Please have a look at the #40. I did take a shot at this...

@justmiles justmiles changed the title How to handle links support linked documents Dec 28, 2023
@justmiles
Copy link
Owner

This is available in v4.0.0-alpha-2

@justmiles justmiles added the v4 label Jan 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed v4
Projects
None yet
Development

No branches or pull requests

4 participants