Describe how to use build artifact from a docu repo PR to create the webpage

[pgfeller]

To verify if changes in the documentation repository break the webpage build it should be possible to build the page using the artifacts built by a PR from the documentation repository.

Follow up to #452

@stefan-hoehn Please assign to me - I'll have a look into this next once/if the PR #454 makes it into main.

[stefan-hoehn]

let me know if you want to do a joint session with me to try it out.

[pgfeller]

@stefan-hoehn

fyi: ... there's progress - but still have to fix a few issues - probably I missed something obvious. That's how it looks atm if you build from a PR:

bsh $ ARGUMENTS="--pull-request 2271" npm run build-local --silent

> openhab-website@3.0.0 prebuild-local
> npm run prepare-docs

> openhab-website@3.0.0 prepare-docs
> ruby prepare-docs.rb $ARGUMENTS

🧹 cleaning existing documentation downloads ...
➡️ PR 2271 will be used to build documentation
➡️ Deleting .vuepress/openhab-docs if existing...
➡️ Cloning repository openhab-docs 📦 ...
➡️ PR Title: [CI/CD] - The preview link created by the pipeline point to an empty page (pgfeller:pgfeller/issue2269 @ SHA [6c28427f6a3fc867225ecc9206e5b6bd0f973edc]
Cloning into 'openhab-docs'...
remote: Enumerating objects: 1202, done.
remote: Counting objects: 100% (1202/1202), done.
remote: Compressing objects: 100% (1181/1181), done.
remote: Total 1202 (delta 13), reused 1062 (delta 8), pack-reused 0
Receiving objects: 100% (1202/1202), 40.15 MiB | 17.27 MiB/s, done.
Resolving deltas: 100% (13/13), done.
➡️ Migrating the introduction article
➡️ Migrating common images
➡️ Migrating logos
➡️ Migrating the Concepts section
 -> index.md
 -> things.md
 -> units-of-measurement.md
 -> rules.md
 -> audio.md
 -> discovery.md
 -> profiles.md
 -> items.md
 -> images and diagrams
➡️ Migrating the Installation section
 -> security.md
 -> linux.md
 -> index.md
 -> synology.md
 -> docker.md
 -> macos.md
 -> armbian.md
 -> reverse-proxy.md
 -> windows.md
 -> images
➡️ Migrating the Tutorial section
 -> pages_intro.md
 -> auto_overview.md
 -> first_steps.md
 -> rules_advanced.md
 -> rules_scenes.md
 -> things_advanced.md
 -> persistence.md
 -> rules_introduction.md
 -> index.md
 -> rules_basic.md
 -> rules_overview.md
 -> model.md
 -> tips-and-tricks.md
 -> custom_widgets.md
 -> things_simple.md
 -> rules_blockly.md
 -> things_intermediate.md
 -> item_widgets.md
 -> images
➡️ Migrating the Configuration section
 -> addons.md
 -> rules-dsl.md
 -> apitokens.md
 -> websocket.md
 -> multimedia.md
 -> index.md
 -> jsr223.md
 -> services.md
 -> restdocs.md
 -> rules-ng.md
 -> editors.md
 -> transformations.md
 -> actions.md
 -> items.md
 -> persistence.md
 -> things.md
 -> images
➡️ Migrating the Settings section
 -> images
/home/pgfeller/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:1225:in `stat': No such file or directory @ rb_file_s_stat - .vuepress/openhab-docs/settings/images (Errno::ENOENT)

[stefan-hoehn]

Thanks for staying on it 🙏🏻

[pgfeller]

Hi @stefan-hoehn - not sure if it is that important anymore to create the web page from a pr - especially as there are some limitations because of missing git workflow actions that were not executed for a PR ... however - i used PR #2272 from the docu repo for a poc

.... I'll create the PR - so that you and maybe @florian-h05 can have a look if it improves the build overall - or if we drop this.

[pgfeller]

@florian-h05 & @stefan-hoehn

I hope you're both fine! I'll keep this one on hold until I get your opinion if you deem it useful.

@stefan-hoehn: Feel free to send me a PM if you would like to see it in action/try it out, if you think that gives a better idea what the value of this possibility could be.

I'm not in a hurry and also quite busy as usual - so no pressure. I just go trough my todo list to see what I do next ... atm I'm quite busy with the huesync binding - as this is a functionality I need for me 🙂.

[florian-h05]

Hi @pgfeller, sorry for not responding … I have been quite busy with university and the UI the last weeks, I hope I will have a look at this the next week.

[stefan-hoehn]

I was also away for sometime, @pgfeller and I am now "back". So if you want, we can schedule another joint session.

I am curious what the huesync binding is about 👀