Skip to content

Conversation

IshaanDesai
Copy link
Member

In precice/calculix-adapter#143 the CalculiX adapter was changed to use the header-only YAML. Hence the information about yaml-cpp as a dependency needs to be removed.

@IshaanDesai IshaanDesai requested a review from fsimonis July 8, 2025 13:02
Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

Looks good, provided that the update is released.
I will review the pending PRs, and we can then release everything together.

@fsimonis
Copy link
Member

fsimonis commented Jul 9, 2025

General question: how do we handle documentation of older versions?

The YAML-cpp documentation is still relevant for everything prior to the latest/upcoming version.

@MakisH
Copy link
Member

MakisH commented Jul 9, 2025

General question: how do we handle documentation of older versions?

The YAML-cpp documentation is still relevant for everything prior to the latest/upcoming version.

That's why I suggested a {% compatibility %} alert in #542 (comment)

Assuming we don't want that for some reason, the current strategy is only relying on the exported PDF: https://precice.org/fundamentals-previous-versions.html

@fsimonis
Copy link
Member

fsimonis commented Jul 9, 2025

That's why I suggested a {% compatibility %} alert in #542 (comment)

Explaining how to install yaml cpp and how to set everything up is enough content for a subsection. It's too much for an alert/note.

Assuming we don't want that for some reason, the current strategy is only relying on the exported PDF: https://precice.org/fundamentals-previous-versions.html

So far, this versioning strategy has been regarding preCICE configuration etc. We never nailed down a strategy on how to handle adapter/binding/tooling versions. I also don't have a good idea on how to handle that.

@MakisH
Copy link
Member

MakisH commented Jul 9, 2025

Let's continue in a separate issue for the general strategy: #548

@MakisH
Copy link
Member

MakisH commented Jul 17, 2025

I will implement the compatibility label for #548 and add one here.

@MakisH MakisH self-assigned this Jul 17, 2025
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.

This information needs to be kept around as long as it is relevant.

Copy link
Member

Choose a reason for hiding this comment

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

This system is anyway decommissioned, and the page is extremely outdated, so I would rather remove it.

Copy link
Member

Choose a reason for hiding this comment

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

@fsimonis the bottom of that page states that one can use CMake to build the adapter. Is this a relic of your past endeavors? This section should probably be removed.

Not sure how much of the rest of the content is relevant to anyone.

@MakisH MakisH requested a review from fsimonis September 4, 2025 16:29
Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

I updated all pages to keep the information but add version context around it. Looks ready to merge for me.

We could additionally discuss on whether the SuperMUC page still makes sense to keep around, but I have added the context there as well.

@MakisH MakisH merged commit c24f36a into master Sep 9, 2025
2 checks passed
@MakisH MakisH deleted the ccx-yaml-update branch September 9, 2025 10:02
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.

3 participants