search

pawelsikora / mkdocs-with-confluence

MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API
MIT License
67 stars 33 forks source link

upload via md2cf #5

Open aogier opened 2 years ago

aogier commented 2 years ago

Hello, what about using md2cf APIs also for uploading to confluence? It's an alive project, it would eliminate lot of duplicated efforts and expose some neat feature like the on_changed machinery which only upload changed stuff.

I think that would be a great addition to your super cool plugin! If you think we could discuss that I could definitely work on that, so what do you think?

Thank you, regards

jannismain commented 2 years ago

I would also be interested in this. I'd also be willing to collaborate / contribute on this.

pawelsikora commented 2 years ago

Hi, I have nothing against it.

Probably didn't see it while implementing and focused mainly of converting markdown to confluence storage format via md2cf instead of using it for uploads. Initially I started from working python script and moved my REST api code into the plugin code.

But sure, why not - no reason to reimplement the wheel, specially when it will provide additional benefits.

Do you have any example of change so we can try that and discuss?

aogier commented 2 years ago

I'm not sure what exactly an example of change could be, what I see is a refactor where upload work is delegated to md2cf which is a superior solution. Unfortunately I will switch job soon and fortunately for me I'll stop being miserable w/ confluence so I'll not have a setup to test against, thus no contributions on that. But thanks for the attention! :)

jannismain commented 2 years ago

I'm currently evaluating whether using something like md2cf directly would serve my needs better than trying to make mkdocs publish to confluence for me. So far, I'd like the additional markdown syntax from mkdocs + plugins to be (at least partially) supported by my confluence publishing pipeline. I also need full control over which files are being published and which not (e.g. only publish a single page to confluence).

@pawelsikora Is this something you'd like mkdocs-with-confluence to be able to do? Or would you rather focus on the more regular use case, which is publishing complete docs to confluence?

pawelsikora commented 2 years ago

@jannismain actually, I would rather happy so see it working in a more generic way. Having more control over the files to be published seems like good way to go. Interesting in implementation, as I would not assume going into some list of files only.

Definitely would like to discuss it more and I will find some time for this. If you would like, just drop me a mail on this.