[Git][reproducible-builds/reproducible-website][master] 4 commits: readme: add developer documentation
Chris Lamb (@lamby)
gitlab at salsa.debian.org
Thu Nov 7 19:06:39 UTC 2024
Chris Lamb pushed to branch master at Reproducible Builds / reproducible-website
Commits:
cfbdd15b by hulkoba at 2024-08-26T09:42:16+02:00
readme: add developer documentation
- - - - -
30ed8207 by hulkoba at 2024-08-26T09:42:19+02:00
docs: remove i18n documentation for now
- buster-backports is not even LTS any more but is required for this feature
- - - - -
03dd5e0c by hulkoba at 2024-08-26T09:42:19+02:00
remove translation icon from navbar
since this is not working
- - - - -
ec0a4a2b by Chris Lamb at 2024-11-07T11:06:31-08:00
Merge branch 'reproducible-website-improve_dev_doc'
* reproducible-website-improve_dev_doc:
remove translation icon from navbar
docs: remove i18n documentation for now
readme: add developer documentation
- - - - -
2 changed files:
- README.md
- _includes/navbar.html
Changes:
=====================================
README.md
=====================================
@@ -1,51 +1,67 @@
-Source for the reproducible-builds.org website
-==============================================
+# Source for the reproducible-builds.org website
-The website for reproducible-builds.org is made with [Jekyll]. It has
-been initially created and tested with version 2.2.0 in Debian unstable
-available in the `jekyll` package, though nowadays it also needs the
-`ruby-jekyll-redirect-from`, `ruby-jekyll-polyglot` and `ruby-jekyll-sitemap`
-packages from buster-backports or later.
+The website for reproducible-builds.org is made with
+[Jekyll](https://jekyllrb.com/), a static site generator. Markdown files
+are automatically published on the
+[Reproducible Builds](https://reproducible-builds.org/) website.
-[Jekyll]: https://jekyllrb.com/
-Viewing the website
--------------------
+## Prerequisites
-It's possible to view the website while making changes:
+Before running the website, make sure you have
+[installed and set up jekyll with all it's requirements](https://jekyllrb.com/docs/).
- $ jekyll serve --watch
+Install jekyll plugins
+```sh
+gem install jekyll-redirect-from jekyll-polyglot jekyll-sitemap
+```
+
+## Local development
+
+Start the local development server with `jekyll serve`.
+
+Pass the `--livereload` option to serve to automatically refresh the
+with each change you make to the source files:
+
+```sh
+jekyll serve --livereload
+```
+
+Open your web browser and visit <http://localhost:4000> to view the website.
-A local webserver will be started which can be accessed using a browser
-to see changes as they are made.
-Build the website
------------------
+## Build the website
Building the website is made by running:
-```console
-$ ./bin/i18n.sh # optional, includes all the translations
-$ jekyll build
+```sh
+jekyll build
```
The result will be available in the `_site` directory.
-```console
-$ sudo apt install po4a
-```
-Dependencies
-------------
+## Contribute
+
+You want to help, great!
-You can install the required tools and plugins and for building the website like this:
+We have a guideline for you to read:
+[our guide for contributors](https://reproducible-builds.org/contribute).
```console
-$ sudo apt install jekyll git ruby-jekyll-redirect-from ruby-jekyll-polyglot ruby-jekyll-sitemap po4a
+$ sudo apt install jekyll git ruby-jekyll-redirect-from ruby-jekyll-polyglot ruby-jekyll-sitemap
```
-Nix
----
+Basically, it is:
+
+1. Fork the repository
+2. Create your feature branch
+3. Commit your changes
+4. Push to your branch
+5. Create a new Merge Request
+
+
+## Nix
The website can also be built using [Nix](https://nixos.org). The exposed URL will be `http://127.0.0.1:4000`.
=====================================
_includes/navbar.html
=====================================
@@ -17,32 +17,6 @@
{% endif %}
{% endfor %}
- <li class="nav-item dropdown">
- <a class="nav-link dropdown-toggle" href="#" id="languagesNavbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
- <img class="half-opacity" src="{{ "/assets/images/icons/translate-white-24dp.svg" | relative_url }}" alt="change language" height="24" width="24"/>
- </a>
- <div class="dropdown-menu" aria-labelledby="languagesNavbarDropdown">
- {% for tongue in site.languages %}
- <a class="dropdown-item{% if tongue == site.active_lang %} disabled{% endif %}" href="{% if tongue == site.default_lang %}{{ site.baseurl }}{{ page.url }}{% else %}{{ site.baseurl }}/{{ tongue }}{{ page.url }}{% endif %}">{{ site.data.languagenames[tongue] }}</a>
- {% endfor %}
- </div>
- </li>
-
</ul>
-
</div>
-
- <ul class="navbar-nav display-md">
- <li class="nav-item dropdown">
- <a class="nav-link dropdown-toggle" href="#" id="navbarDropdownMenuLink" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
- <img class="half-opacity" src="{{ "/assets/images/icons/translate-white-24dp.svg" | relative_url }}" alt="change language" height="24" width="24"/>
- </a>
- <div class="dropdown-menu dropdown-menu-right" aria-labelledby="navbarDropdownMenuLink">
- {% for tongue in site.languages %}
- <a class="dropdown-item{% if tongue == site.active_lang %} disabled{% endif %}" href="{% if tongue == site.default_lang %}{{ site.baseurl }}{{ page.url }}{% else %}{{ site.baseurl }}/{{ tongue }}{{ page.url }}{% endif %}">{{ site.data.languagenames[tongue] }}</a>
- {% endfor %}
- </div>
- </li>
- </ul>
-
</nav>
View it on GitLab: https://salsa.debian.org/reproducible-builds/reproducible-website/-/compare/0f789482e6ff52bd805afbdebb3c737c07d8c8b3...ec0a4a2b5b3495c335023e9fe3139994b42950c3
--
View it on GitLab: https://salsa.debian.org/reproducible-builds/reproducible-website/-/compare/0f789482e6ff52bd805afbdebb3c737c07d8c8b3...ec0a4a2b5b3495c335023e9fe3139994b42950c3
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20241107/2cd6d658/attachment.htm>
More information about the rb-commits
mailing list