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

Restore comments in news_banner.html (and disable banner) #453

Closed
wants to merge 1 commit into from

Conversation

MakisH
Copy link
Member

@MakisH MakisH commented Sep 16, 2024

These comments were moved to the README.md in d68cf8a, but I think they are useful in the file as well, for quick access.

Even if we end up disagreeing about this, we need at least a link to the README from the file itself (and potentially move the whole thing into https://precice.org/docs-meta-overview.html or a subpage).

Also disables the banner of the workshop registration, per @IshaanDesai's request.

@MakisH MakisH added the technical Technical issues on the website label Sep 16, 2024
@MakisH MakisH self-assigned this Sep 16, 2024
Copy link
Member

@fsimonis fsimonis left a comment

Choose a reason for hiding this comment

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

Firstly, can we reword the workshop banner instead of disabling it?
I find the banner super useful to quickly get to the workshop page.
Example: Attending the preCICE Workshop 2024? Click to see the program.

Secondly, I personally think there is 0 reason to duplicate the comments in the include file, to keep the code around, and to link back to the Readme. If you know this file exists, then you don't need the comments. If you don't, then you need to read the Readme.

I moved the code example and documentation to the Readme because it is easier to find, allows for more verbose documentation, and doesn't mess with formatting of the rest of the file due to nested tags.

This is not important, you don't need my review, and won't get my OK.

@fsimonis fsimonis requested review from fsimonis and removed request for fsimonis September 16, 2024 09:32
@IshaanDesai
Copy link
Member

Having a workshop banner still is a good idea indeed 👍 Let us indeed have Attending the preCICE Workshop 2024? Click to see the program.

I stay clear of the other crossfire.

@MakisH
Copy link
Member Author

MakisH commented Sep 16, 2024

Firstly, can we reword the workshop banner instead of disabling it? I find the banner super useful to quickly get to the workshop page. Example: Attending the preCICE Workshop 2024? Click to see the program.

Sure, this was just implementing a request.

Secondly, I personally think there is 0 reason to duplicate the comments in the include file, to keep the code around, and to link back to the Readme. If you know this file exists, then you don't need the comments. If you don't, then you need to read the Readme.

My journey leading to this:

  • I had previously searched for the content of the banner to find the right file (so, my entry point it different)
  • I saw the content outside an empty if structure
  • I looked into the git blame to find again what options were there, saw the bit about documentation
  • Went to the documentation page on the website, did not see it there
  • Went back to the previous PR, so it was actually in the README

Next time I will probably go again to the documentation, not find anything there, and then end up by chance finding something in the README.

Sure, let's not duplicate, but do we agree on the need for a back-reference, due to the different entry point?

I moved the code example and documentation to the Readme because it is easier to find, allows for more verbose documentation, and doesn't mess with formatting of the rest of the file due to nested tags.

This is not important, you don't need my review, and won't get my OK.

I understand that the file looks messier like this.

I will open another PR suggesting to move the documentation to a different place and add a link to that. I am just looking for a better solution.

@MakisH MakisH closed this Sep 16, 2024
@MakisH MakisH deleted the news-banner branch September 16, 2024 11:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical Technical issues on the website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants