From 63132830f6671d5265f2da769adc5f5aa58ace0a Mon Sep 17 00:00:00 2001 From: "Rodney, Tiara" Date: Sun, 16 Mar 2025 19:08:41 +0100 Subject: [PATCH] doc(README): add refactor disclaimer --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5f987be..46f5f6e 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ # PSConfluencePublisher +> NOTE: Due to the functionality of `xconfluencebuilder` now being part of the + official + [sphinxcontrib-confluencebuilder](https://github.com/sphinx-contrib/confluencebuilder) + project, I am planning on refactoring to support [the official + integration](https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/configuration/#confval-confluence_manifest_data). + I wanted to do so anyway, since I want the test suite to both support Pester + v3 and v5, which is a little tricky. The past committer is a pseudonym I've + used, which I will drop for future commits. + This program is a standalone publisher component for the -[victorykit-xconfluencebuilder](https://bitbucket.org/victorykit/xconfluencebuilder) +[victorykit-xconfluencebuilder (DEFUNCT)](https://bitbucket.org/tiaracodes/xconfluencebuilder) Sphinx extension. It consumes, a JSON-formatted manifest of a *Sphinx build* dump generated by @@ -39,11 +48,11 @@ PS > Install-Module victorykit.PSConfluencePublisher Alternatively, you can import the module from source. In order to do that, clone the -[Git repository](https://bitbucket.org/victorykit/psconfluencepublisher/src) +[Git repository](https://bitbucket.org/tiaracodes/psconfluencepublisher/src) , change into the directory and import it. ``` -PS> git clone git@bitbucket.org:victorykit/psconfluencepublisher.git +PS> git clone git@bitbucket.org:tiaracodes/psconfluencepublisher.git ``` ```