rock-core / base-doc

Rock's website
0 stars 11 forks source link

Update website #48

Closed mintar closed 5 years ago

mintar commented 8 years ago

The website has not been regenerated for at least a year or so. For example, bffdb33f has still not arrived on the website. I noticed because I was about to fix the same thing again.

maltewi commented 7 years ago

I wanted re-raise this issue. Website generation still seems to be down.

@planthaber, @doudou, @2maz : Does someone of you know what need to be done to get it running again?

planthaber commented 7 years ago

https://github.com/rock-core/base-admin_scripts/pull/2 has to be finished, I currently do not have time to care about the script.

On long term it would be nice to separate doc generation and Website content updates in a way that the content of base-doc is updated even if the doc genreration for all the packages fails

maltewi commented 7 years ago

Okay. Meanwhile, would it be possible to trigger the website generation manually. Commits come in slowly (every few months), so manually triggering would be feasible.

planthaber commented 7 years ago

"manual trigger" means executing the script mentioned.

planthaber commented 7 years ago

We just discussed to try to move the content from this repo to github pages, and only generate the package list and doxygen documentation "the old way".

The new page layout would include changing the "master/stable" documentation to be folder based. On each release the current "master" pages would be copied to a folder named by the release name and is not touched anymore, to preserve the documentation of that release in the state it was in at release time.

Any thoughts?

doudou commented 7 years ago

We just discussed to try to move the content from this repo to github pages, and only generate the package list and doxygen documentation "the old way".

This sounds like the right approach. So some people are ready to convert this to jekyll ? This depends on webgen < 1.0 and will stop to be "generable" one way or the other.

My plan for the packages was to scrap the current system which is the real source of the problem, generate JSON files and have javascript generate the package browsing on the frontend.

planthaber commented 6 years ago

Did a update manually and wanted to do some documentation, the procedure is as follows:

Start a Ububntu 14.04 docker (ruby 1.8)

$> apt-get update
$> apt-get install git ruby-dev rubygems lftp

$> git config --global user.email "you@example.com"
$> git config --global user.name "Your Name"

$> git clone https://github.com/rock-core/base-doc.git
$> gem install cmdparse -v 2.0.6 --no-rdoc --no-ri
$> gem install kramdown -v 1.4.0 --no-rdoc --no-ri
$> gem install webgen -v 0.5.17 --no-rdoc --no-ri

$> cd base-doc

$> webgen

$> cd out
$> lfpt 
:~>open -u $UPLOAD_USER,$UPLOAD_PASSWD $FTP_URL
:~>mirror -v -R --only-newer --parallel=8 --delete --use-cache --exclude status/ ./ www/
planthaber commented 6 years ago

As this is docker approach works, I am wondering if we could stay on this webgen version and use a docker-based CI to push the static page to github.io.

doudou commented 6 years ago

It seems that the update broke access to https://www.rock-robotics.org/autoproj_bootstrap

planthaber commented 6 years ago

True, just fixed it.

The .htaccess file is not part of this template, when doing the update, i did a completely fresh upload. I reinstalled the .htascess file from the backup.

We also lost master and stable versions of the website, but i guess this is ok for now, right?

doudou commented 6 years ago

i guess this is ok for now, right?

Totally

planthaber commented 6 years ago

Hi,

@2maz, @kirishanthchethurajah: FYI

Kirishanth migrated the current website from webgen to jekyll, to be able to use github.io for the rock homepage:

Please check it here: https://kirishanthchethurajah.github.io/

"browse packages" is broken, but that needs external tooling anyway, so not curetnly an issue. Should we remove it?

If there is no issue, i'd propose moving the repo to rock-core and let the rock-robotics.org point to the github.io page.

But first need to fix redirects (e.g. https://www.rock-robotics.org/autoproj_bootstrap) in the .io page: Github has this enabled: https://github.com/jekyll/jekyll-redirect-from

planthaber commented 6 years ago

Any comments?

2maz commented 6 years ago

IMO you can already move it to rock-core and then fix the redirection issue.

doudou commented 6 years ago

Should we remove it?

I would say "yes"

2maz commented 5 years ago

I migrated now the old base-doc webgen based content to jekyll and included some additional fixes. Please @doudou @planthaber check if you spot remaining issues. https://rock-core.github.io/documentation/index.html

planthaber commented 5 years ago

We could replace/remove the browse packages section.

Also the Core/Build system/Autoproj and autobuild API lkinks are broken.

planthaber commented 5 years ago

The Community Links is broken and we should decide it we should remove the "news", which were last updated 2015.

2maz commented 5 years ago

We could replace/remove the browse packages section.

Ack

Also the Core/Build system/Autoproj and autobuild API lkinks are broken.

Sure about that - these links are already fixed? Please ensure you did not accidentally jump to rock-robotics.org but stayed on https://rock-core.github.io/documentation/autoproj/index.html

2maz commented 5 years ago

The Community Links is broken and we should decide it we should remove the "news", which were last updated 2015.

I now changed the news sections to use jekyll post mechanism, so news have to be added under _posts.

Cannot see any issue with the community link: https://rock-core.github.io/documentation/contributing/index.html?

planthaber commented 5 years ago

community now works, but new is a 404 now

2maz commented 5 years ago

new is fixed now

2maz commented 5 years ago

I activated a redirect from rock-robotics.org

2maz commented 5 years ago

DNS Records have been updated so that rock-robotics.org is now pointing to the github.io page. From my perspective the migration is completed and I will therefore close this issue.

For issues with the updated website please use: https://github.com/rock-core/rock-core.github.io/issues or directly create a merge request https://github.com/rock-core/rock-core.github.io/pulls