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

Tweaks for docs #6246

Merged
merged 1 commit into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,28 @@ using [GitHub Pages](https://help.github.com/articles/what-are-github-pages/).
# Build it
./build.sh
```

## Setup local docs development environment (MacOS)

If you get an error like `activesupport-7.0.7.2 requires ruby version >= 2.7.0, which is incompatible with the current version, ruby 2.6.10p210` when executing `./run.sh` then consider doing the following:

- Install rbenv Ruby Version manager https://github.com/rbenv/rbenv e.g. via brew
- and then use it to install and use e.g. ruby 3.1.2

```
brew install rbenv
rbenv init
rbenv install 3.1.2
rbenv global 3.1.2
./run.sh
```

After a successfull start of `./run.sh` you see this:

```
Server address: http://127.0.0.1:4000
Server running... press ctrl-c to stop.
```

Open http://127.0.0.1:4000 in your browser to see the result while developing.
The server does support hot-reload so you should see changes to `.md` files immediately without restart (there are a few exceptions). Checkout the [jekyll-docs](https://jekyllrb.com/docs/pages/) to get more into the details and features.
2 changes: 1 addition & 1 deletion docs/_chapters/120-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The manual is also on [github][5]. If you see an improvement, do not hesitate to

If you're behind a firewall that requires proxies or you use repositories that require authentication see [-connection-settings][6].

[1]: https://brew.sh/
[1]: https://formulae.brew.sh/formula/bnd
[3]: https://github.com/bndtools/bnd
[4]: https://bndtools.jfrog.io/bndtools/libs-snapshot
[5]: https://github.com/bndtools/bnd/tree/master/docs
Expand Down
10 changes: 3 additions & 7 deletions docs/_data/sidebar.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
nav:
- title: Introduction
subfolderitems:
- url: /chapters/110-introduction.html
- title: Installation
subfolderitems:
- url: /chapters/120-install.html
- title: Getting Started
subfolderitems:
- url: /chapters/120-install.html
- url: /chapters/123-tour-workspace.html
- url: /chapters/125-tour-features.html
- url: /chapters/920-faq.html
- title: Concepts and Practices
subfolderitems:
- url: /chapters/110-introduction.html
- url: /chapters/130-concepts.html
- url: /chapters/140-best-practices.html
- title: Build and Development
Expand Down Expand Up @@ -62,4 +59,3 @@ nav:
- url: /chapters/880-settings.html
- url: /chapters/900-errors.html
- url: /chapters/910-warnings.html
- url: /chapters/920-faq.html
10 changes: 10 additions & 0 deletions docs/_layouts/front.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@
<img span=12 src="{{ '/img/front-page.png' | prepend:site.baseurl }}">
</div>

<div class=container12>
<h4 style="text-align: center">Bnd is a tooling suite for building OSGi bundles.
Its primary function is generating OSGi meta data by analyzing Java classes.
<br />
There are plugins for popular tools like Eclipse, Maven and Gradle.
</h4>
</div>



<ul class=container12>
<li span=4>
<h1>What is bnd?</h1>
Expand Down
1 change: 1 addition & 0 deletions docs/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ set -ev

export BUNDLE_GEMFILE=$PWD/Gemfile
bundle install --jobs=3 --retry=3
bundle exec jekyll clean
bundle exec jekyll serve -w --incremental