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.

Sign up for GitHub

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

Jump to bottom

Redo FEniCS-preCICE adapter handling of literature #97

Merged
merged 5 commits into from
Nov 17, 2021
Merged

Redo FEniCS-preCICE adapter handling of literature #97

merged 5 commits into from
Nov 17, 2021

Conversation

ajaust
Copy link
Contributor

@ajaust ajaust commented Oct 31, 2021

This PR cleans up the way the FEniCS-preCICE adapter's documentation handles literature.

Main changes

  • Updated style of references to be consistent with the reference list of homepage
  • Generate the reference lists automatically from the publication list of this homepage. I added some extra fields for publications (for the Rodenberg2021 and Hertrich2019 publication) which allow for easier sorting literature-dependent formatting. For example, the output of a Bachelor's thesis looks different than for a journal paper.
  • Remove hard coded links within the text, e.g., 'see [1]'" ../../pages/docs/adapters/fenics/adapter-fenics.md
  • Added a bib file for the FEniCS-preCICE adapter.

Current issues (I am aware of)

  • The appearance of the FEniCS-preCICE adapter's literature box on the adapter page now differs from the appearance on the general "Publictions" page of the preCICE homepage.
  • Is the addition of fields for the literature ok? I added some (and already abuse the notation slightly) for the added fiels.

Further notes

This PR replaces #96.

ajaust added 3 commits October 31, 2021 13:11
@ajaust
[literature] restructure hertrich paper
df39d94
@ajaust
[literature] update rodenberg2021 paper and add bibtex file
47b7873
@ajaust
[literature][doc] update fenics-precice adapter
6081b7c 
- Updated style of references to be consistent with the reference list of homepage
- Generate the reference lists automatically from the publication list of this homepage. I added some extra fields for publications
- Remove hard coded links within the text, e.g., 'see [1]'
@ajaust
Copy link
Contributor Author

ajaust commented Oct 31, 2021

@BenjaminRodenberg I think I would need feedback from you and someone who is responsible for the homepage design whether the addition of fields in publications is acceptable (for the moment) or whether one wants to set this up differently.

This was referenced Oct 31, 2021
Closed
Closed
@BenjaminRodenberg BenjaminRodenberg self-requested a review November 17, 2021 09:37
BenjaminRodenberg
BenjaminRodenberg approved these changes Nov 17, 2021
View reviewed changes
Copy link
Member

@BenjaminRodenberg BenjaminRodenberg left a comment

Choose a reason for hiding this comment

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

I had a quick look at the details and it is definitely a big improvement compared to the current state. About the website styling and policies I cannot give a comprehensive review. @MakisH could you have a brief look here?

If there are bigger workpackages w.r.t restructuring the documentation, I think we could also merge this PR, because it updates the (currently outdated) citing information and continue on the restructuring in a new PR.

@ajaust
Copy link
Contributor Author

ajaust commented Nov 17, 2021

If this redo is fine, I would work on getting this merged first. Redoing parts of the homepage and how to work with citations could be done somewhere else. It would probably make sense to also take some time to build some (somewhat) consistent templates for different types of references (theses, papers, proceedings etc.)

@ajaust
Copy link
Contributor Author

ajaust commented Nov 17, 2021

Regarding the potential redoing part the is also an issue #98

If this PR is approved of, I would maybe still reformat this line such that it is easier to understand/debug.

@BenjaminRodenberg
Copy link
Member

Regarding the potential redoing part the is also an issue #98

If this PR is approved of, I would maybe still reformat this line such that it is easier to understand/debug.

Ok. Then I will wait with merging here until you trigger me again, ok?

@ajaust
Copy link
Contributor Author

ajaust commented Nov 17, 2021

I attached a screenshot how it looked for me after the changes:

2021-11-17-screenshot-precice-homepage

I added the changes to make it (a bit more) verbose. To make it properly verbose a bit more work would be needed. It is not clear to me how to ideally prevent additional space characters from popping up. These space character tend to mess up the formatting, but that should be beyond this PR.

@ajaust
Copy link
Contributor Author

ajaust commented Nov 17, 2021

I forgot to add that this is ready to merge from my side now.

@BenjaminRodenberg BenjaminRodenberg merged commit d8f7958 into precice:master Nov 17, 2021
@ajaust ajaust deleted the redo-fenics-precice-docs branch November 17, 2021 15:40
BenjaminRodenberg added a commit to precice/fenics-adapter that referenced this pull request Nov 17, 2021
@BenjaminRodenberg
Remove duplicate information on citing
313d922 
Follow-up to precice/precice.github.io#97
@BenjaminRodenberg BenjaminRodenberg mentioned this pull request Nov 17, 2021
Closed
@MakisH
Copy link
Member

MakisH commented Nov 17, 2021

This looks indeed really nice and I will definitely like to have the same in every adapter! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BenjaminRodenberg BenjaminRodenberg BenjaminRodenberg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ajaust @BenjaminRodenberg @MakisH