Skip to content

Conversation

odow
Copy link
Member

@odow odow commented Sep 1, 2021

The Python ecosystem do this. I think it works quite well: http://xarray.pydata.org/en/latest/whats-new.html

It's doubly important for this release of MOI because there are such a large number of changes.

@odow odow added the Type: Documentation This issue requires changes to the documentation label Sep 1, 2021
@odow
Copy link
Member Author

odow commented Sep 1, 2021

@blegat
Copy link
Member

blegat commented Sep 1, 2021

Why not keeping NEWS.md where it is ? So that it can be accessed directly in addition to being in the docs ? An advantage of having it in the docs is that we can use Documenter features such as @ref. In that case, we can move it in docs/src but then we would need a clear link to if from the README

@odow
Copy link
Member Author

odow commented Sep 1, 2021

Why not keeping NEWS.md where it is ? So that it can be accessed directly in addition to being in the docs ?

You can still link directly: https://github.com/jump-dev/MathOptInterface.jl/blob/od/release_notess/docs/src/release_notes.md

How often to people actually check the NEWS.md file? Adding it to the docs makes it much more visible. We could add a placeholder NEWS.md that just says "check the docs"?

having it in the docs is that we can use Documenter features such as @ref

I thought about this, but then when we remove things like SingleVariable you just break all the previous links. We could get better at writing detailed release notes with links to the PRs through.

odow and others added 3 commits September 2, 2021 10:42
@odow odow force-pushed the od/release_notess branch from b5eda29 to cf1be04 Compare September 1, 2021 22:43
@odow odow merged commit 0f21fc6 into master Sep 1, 2021
@odow odow deleted the od/release_notess branch September 1, 2021 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation This issue requires changes to the documentation
Development

Successfully merging this pull request may close these issues.

3 participants