https://github.com/gnu-octave/gnu-octave.github.io
Repository for the https://octave.org website.
https://github.com/gnu-octave/gnu-octave.github.io
Last synced: 3 months ago
JSON representation
Repository for the https://octave.org website.
- Host: GitHub
- URL: https://github.com/gnu-octave/gnu-octave.github.io
- Owner: gnu-octave
- License: gpl-3.0
- Created: 2020-09-10T06:46:46.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2026-03-31T12:33:59.000Z (3 months ago)
- Last Synced: 2026-03-31T14:38:35.068Z (3 months ago)
- Language: HTML
- Homepage:
- Size: 3.38 MB
- Stars: 14
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GNU Octave Website development
This is the website development repository.
The development and deployment workflow in short:
1. The website development repository is located at:
-
2. Static HTML pages are generated from these repositories
and deployed at
- (Digital Ocean)
- (GitHub Pages for testing)
3. For testing changes,
updates to GitHub Pages happen automatically by pushing to the respective repository.
4. The deployment on Digital Ocean has to be done manually.
1. Login to the Digital Ocean server with root permissions.
2. ```
cd /var/www/www.octave.org/
rvm use 3.3.1
git pull
bundle install
bundle exec jekyll build
chown -R root:www-data *
chown -R root:www-data .*
```
3. Changes are now live on .
The static website is build to the `/var/www/www.octave.org/_site` directory
and served from there to .
## Simple website changes / contributions
Anyone is free to clone this website development repository, simply type
git clone https://github.com/gnu-octave/gnu-octave.github.io.git
to get anonymous read access without writing privileges.
If you want submit changes/additions, please create a
[**pull request**](https://docs.github.com/en/github/getting-started-with-github/github-glossary#pull-request)
on GitHub or contact the Octave developers at .
> **Note:** Changes made to the GitHub page repository are only visible there.
> To change , the updates must be deployed manually on Digital Ocean.
### Add a new RSS post
Duplicate another post in the subdirectory `_posts` and adjust the filename,
especially the date.
**Be sure to choose the correct categories!!**
`categories: news release` is reserved for release announcements, those posts
are also displayed inside the Octave GUI. Consider choosing another category
like `categories: news` or alike for less important news.
## Advanced development
### Building requisites
To build the static website offline, you need to install [Bundler][].
For Debian/Ubuntu please perform the following setup fist.
For other Linux distributions this command might change.
sudo apt-get install bundler
From now on, everything is handled by Bundler. Install all required
dependencies for the static Octave website by running
bundle install
from within the checked-out website development repository.
For the responsive webpages, we internally use the [Foundation 6][Foundation]
framework. All necessary files are already included inside this website
development repository.
[Bundler]: https://bundler.io/
[Foundation]: https://get.foundation/sites/docs/
### Building the static website offline
All relevant information for Bundler to build the static website are located in
the files `_config.yml`, `Gemfile`, and `Gemfile.lock`. Typing
bundle exec jekyll build
from the repository root directory will build a complete static website
into the subdirectory `_site` using this information. This directory is
ignored by Mercurial and will be created on first build.
Especially for development, it is beneficial to watch the changes locally
before pushing any changes. Jekyll provides a local webserver by typing
bundle exec jekyll serve
and rebuilds the whole static website automatically, as it monitors any
file changes.
## License
### Website Design and Code
- Copyright (c) 2016-2023 The Octave Project Developers.
- Copyright (c) 2015-2016 Alex Krolick.
See the file LICENSE in the top-level directory of this distribution or
.
The Octave website is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version.
The Octave website is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with the Octave website; see the file COPYING. If not, see
.
### Website Content
The website content is licensed under a
[Creative Commons Attribution-NoDerivatives 4.0 International License](https://creativecommons.org/licenses/by-nd/4.0/).