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

Improve citation section of Readme #81

Closed
wants to merge 5 commits into from

Conversation

orzechow
Copy link
Member

This collapses all but one citation for better appearance.
It also adds my thesis to the citations.

@orzechow
Copy link
Member Author

@ll-nick

@orzechow orzechow changed the base branch from main to fix_citations November 20, 2024 00:27
README.md Outdated

_Piotr F. Orzechowski, “Verhaltensentscheidung für automatisierte Fahrzeuge mittels Arbitrationsgraphen,” phd, Karlsruher Institut für Technologie (KIT), 2023. doi: [10.5445/IR/1000160638](https://doi.org/10.5445/IR/1000160638)._

{% raw %}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just like in #83, these don't look great on the GitHub rendered page.

@ll-nick
Copy link
Collaborator

ll-nick commented Nov 20, 2024

I just wanted to view these changes on locally built pages but I get the following error when starting the container. Any idea if that has something to do with this PR? Last week, this still worked.

Attaching to github-pages-dev-1
github-pages-dev-1  | bundler: failed to load command: jekyll (/usr/local/bundle/bin/jekyll)
github-pages-dev-1  | /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/definition.rb:599:in `materialize': Could not find rexml-3.3.8, faraday-2.12.0, execjs-2.9.1, activesupport-7.2.1, faraday-net_http-3.3.0, json-2.7.2, uri-0.13.1 in locally installed gems (Bundler::GemNotFound)
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/definition.rb:193:in `specs'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/definition.rb:260:in `specs_for'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/runtime.rb:18:in `setup'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler.rb:164:in `setup'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/setup.rb:32:in `block in <top (required)>'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/ui/shell.rb:173:in `with_level'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/ui/shell.rb:119:in `silence'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/setup.rb:32:in `<top (required)>'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/cli/exec.rb:56:in `require_relative'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/cli/exec.rb:56:in `kernel_load'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/cli/exec.rb:23:in `run'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/cli.rb:455:in `exec'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/vendor/thor/lib/thor/command.rb:28:in `run'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/vendor/thor/lib/thor/invocation.rb:127:in `invoke_command'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/vendor/thor/lib/thor.rb:527:in `dispatch'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/cli.rb:35:in `dispatch'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/vendor/thor/lib/thor/base.rb:584:in `start'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/cli.rb:29:in `start'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/exe/bundle:28:in `block in <top (required)>'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/lib/bundler/friendly_errors.rb:117:in `with_friendly_errors'
github-pages-dev-1  |   from /usr/local/bundle/gems/bundler-2.5.21/exe/bundle:20:in `<top (required)>'
github-pages-dev-1  |   from /usr/local/bundle/bin/bundle:25:in `load'
github-pages-dev-1  |   from /usr/local/bundle/bin/bundle:25:in `<main>'
github-pages-dev-1 exited with code 1

@orzechow
Copy link
Member Author

Just for the record (we solved this via chat):
These Jekyll issues arise from Gem caches incompatible with upstream changes of Gem dependencies.

Simply git clean your repo and restart the local Jekyll server.

Copy link
Collaborator

@ll-nick ll-nick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this one! Generally I think this is a very nice change and is a nice improvement of the citation section.

I removed the {% raw %} just like in #83. However, the collapsible section does not render properly in Jekyll (see screenshot below). I hope that's not related to any local issues of my Jekyll setup. It does look great in the markdown render.

I added some suggestions regarding horizontal dividers but that's just an idea.

image



<details>
<summary>Earlier publications</summary>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The entire section does not render properly for me via Jekyll. Looks fine on the pure markdown rendering and generally I think it's a good idea to use spoilers here.

<details>
<summary>Earlier publications</summary>

A safety concept that extends Arbitration Graphs with behavior verification and fallback layers in the context of automated driving has been proposed by Piotr Spieker (née Orzechowski) in his PhD thesis.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add horizontal dividers between the publications to distinguish more easily which part belongs where. See also the analogous suggestions below.

Suggested change
A safety concept that extends Arbitration Graphs with behavior verification and fallback layers in the context of automated driving has been proposed by Piotr Spieker (née Orzechowski) in his PhD thesis.
---
A safety concept that extends Arbitration Graphs with behavior verification and fallback layers in the context of automated driving has been proposed by Piotr Spieker (née Orzechowski) in his PhD thesis.

```
{% endraw %}

Arbitration Graphs replaced state machines in the context of automated driving at the Institute of Measurement and Control Systems (MRT) of the Karlsruhe Institute of Technology (KIT):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Arbitration Graphs replaced state machines in the context of automated driving at the Institute of Measurement and Control Systems (MRT) of the Karlsruhe Institute of Technology (KIT):
---
Arbitration Graphs replaced state machines in the context of automated driving at the Institute of Measurement and Control Systems (MRT) of the Karlsruhe Institute of Technology (KIT):


The foundations for Arbitration Graphs have been proposed in the context of robot soccer:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The foundations for Arbitration Graphs have been proposed in the context of robot soccer:
---
The foundations for Arbitration Graphs have been proposed in the context of robot soccer:

@orzechow orzechow deleted the branch fix_citations November 20, 2024 09:02
@orzechow orzechow closed this Nov 20, 2024
@orzechow
Copy link
Member Author

Meh, this should have been fixed by 89e0214 and b0346c4.
Sure you restarted Jekyll after switching to this branch?

@ll-nick
Copy link
Collaborator

ll-nick commented Nov 20, 2024

Let me try again tomorrow. I think I did but let me test it in a clean state to make sure the fault is not in my local setup.

@ll-nick
Copy link
Collaborator

ll-nick commented Nov 21, 2024

Just for reference:

Simply git clean your repo and restart the local Jekyll server.

This did not actually work. I had to rm Gemfile.lock to fix it.

@ll-nick
Copy link
Collaborator

ll-nick commented Nov 21, 2024

Ok, I cleaned the Gemfile one more time and started the local Jekyll setup, now it rendered fine. Therefore I take back my complaints and will approve this PR :)
You'll have to open a new PR though I believe.

@orzechow orzechow mentioned this pull request Nov 21, 2024
@orzechow
Copy link
Member Author

Follow-up PR: #86

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

Successfully merging this pull request may close these issues.

2 participants