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

[Enancement] - Simplify local builds to lower bar for beginners #2215

Closed
pgfeller opened this issue Jan 21, 2024 · 2 comments
Closed

[Enancement] - Simplify local builds to lower bar for beginners #2215

pgfeller opened this issue Jan 21, 2024 · 2 comments
Assignees

Comments

@pgfeller
Copy link
Contributor

At the moment some special knowledge is required how to set environment variables and that errors generated by a local build can be ignored during checking content contribution.

The proposed enhancement aims to simplify to generate the documentation locally using an npm script (e.g. npm run serve). Assuming required dependencies like ruby and python3 are present the documentation builds and starts a local server to verify the changes.

A proof of concept was created while working on PR #2190. To keep the PRs small and to avoid mixing things I propose to do those changes using this issue.

@pgfeller
Copy link
Contributor Author

@stefan-hoehn ... well - I'm not a github expert yet it seems; as I've created a PR on my local repo and merge it there. Anyhow - can you see & review those changes there as well? I think it is possible to move the PR from there to here somehow - or I'll just try again with a new branch.

@stefan-hoehn
Copy link
Contributor

you should be able to go to your branch on github and create a pull request. This would then popup here for review.

pgfeller added a commit to pgfeller/openhab-docs that referenced this issue Feb 2, 2024
Fixes openhab#2215

 - resolved comments by @stefan-hoehn
 - added more information to USB section, as in my expirience to use the device id is more reliable the host system configuration changes.
pgfeller added a commit to pgfeller/openhab-docs that referenced this issue Feb 20, 2024
Fixes openhab#2215

📄 missing `npm install step` added to README.md

Signed-off-by: Patrik Gfeller <[email protected]>
stefan-hoehn added a commit that referenced this issue Mar 2, 2024
#2218)

* [Enancement] - Simplify local builds to lower bar for beginners
Fixes #2215

* [Enancement] - Simplify local builds to lower bar for beginners
Fixes #2215

📄 missing `npm install step` added to README.md

Signed-off-by: Patrik Gfeller <[email protected]>

* 🐞 problems resolved after reabse/update to latest main branch.

Signed-off-by: Patrik Gfeller <[email protected]>

* 🔃 Squashed commit of the following:

commit 6774910
Author: jimtng <[email protected]>
Date:   Sun Feb 25 17:23:01 2024 +1000

    Convert pwm, pid, map icons to svg and add jinja logo (#2253)

    * Replace map icon with svg version

    Signed-off-by: Jimmy Tanagra <[email protected]>

    * Replace pidcontroller icon with svg version

    Signed-off-by: Jimmy Tanagra <[email protected]>

    * Replace pwm icon with svg version

    Signed-off-by: Jimmy Tanagra <[email protected]>

    * Add jinja logo

    Signed-off-by: Jimmy Tanagra <[email protected]>

    ---------

    Signed-off-by: Jimmy Tanagra <[email protected]>

commit 6f39e14
Author: jimtng <[email protected]>
Date:   Sun Feb 25 08:15:21 2024 +1000

    Add icon for scale transformation (#2252)

    Signed-off-by: Jimmy Tanagra <[email protected]>

commit 67a019a
Author: jimtng <[email protected]>
Date:   Sun Feb 25 00:55:02 2024 +1000

    Add pwm icon (#2251)

    Signed-off-by: Jimmy Tanagra <[email protected]>

commit a03e4c0
Author: jimtng <[email protected]>
Date:   Sun Feb 25 00:54:22 2024 +1000

    PIDController icon: Make lines thicker (#2250)

    Signed-off-by: Jimmy Tanagra <[email protected]>

commit 7308a41
Author: Kai Kreuzer <[email protected]>
Date:   Sat Feb 24 14:57:54 2024 +0100

    Fix typo in tutorial (#2249)

    Signed-off-by: Kai Kreuzer <[email protected]>

commit ccb7e64
Author: jimtng <[email protected]>
Date:   Sat Feb 24 18:15:21 2024 +1000

    Make basicui icon a bit bigger and more visible (#2247)

    Signed-off-by: Jimmy Tanagra <[email protected]>

commit d9664d9
Author: jimtng <[email protected]>
Date:   Sat Feb 24 18:10:22 2024 +1000

    Add icon for pidcontroller (#2248)

    Signed-off-by: Jimmy Tanagra <[email protected]>

commit bcba38e
Author: jimtng <[email protected]>
Date:   Sat Feb 24 08:31:23 2024 +1000

    Add an icon for map transformation (#2240)

    Signed-off-by: Jimmy Tanagra <[email protected]>

commit f8ebab4
Author: jimtng <[email protected]>
Date:   Sat Feb 24 03:23:06 2024 +1000

    Add icon for Basic UI (#2242)

    Signed-off-by: Jimmy Tanagra <[email protected]>

commit ab958f9
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Fri Feb 23 18:21:57 2024 +0100

    Bump ip from 1.1.5 to 1.1.9 (#2244)

    Bumps [ip](https:/indutny/node-ip) from 1.1.5 to 1.1.9.
    - [Commits](indutny/node-ip@v1.1.5...v1.1.9)

    ---
    updated-dependencies:
    - dependency-name: ip
      dependency-type: indirect
    ...

    Signed-off-by: dependabot[bot] <[email protected]>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: stefan-hoehn <[email protected]>

commit dedb16a
Author: Florian Hotze <[email protected]>
Date:   Fri Feb 23 16:52:57 2024 +0100

    Use SVG logos for DoorBird & Govee (#2246)

    Signed-off-by: Florian Hotze <[email protected]>

commit 749a656
Author: jimtng <[email protected]>
Date:   Fri Feb 23 18:29:36 2024 +1000

    Add sqlite icon (#2238)

    Signed-off-by: Jimmy Tanagra <[email protected]>

Signed-off-by: Patrik Gfeller <[email protected]>

* Update README.md

Signed-off-by: stefan-hoehn <[email protected]>

* Update README.md

Signed-off-by: stefan-hoehn <[email protected]>

---------

Signed-off-by: Patrik Gfeller <[email protected]>
Signed-off-by: stefan-hoehn <[email protected]>
Co-authored-by: stefan-hoehn <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants