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

4185 remove consensus docs #4374

Merged
merged 2 commits into from
Feb 24, 2023
Merged

4185 remove consensus docs #4374

merged 2 commits into from
Feb 24, 2023

Conversation

dnadales
Copy link
Member

@dnadales dnadales commented Feb 16, 2023 •
edited
Loading

The documentation for Consensus will be now hosted at https://github.com/input-output-hk/ouroboros-consensus/ This is the first step towards migrating the Consensus implementation to this repository.

Part of #4145, and complemented by IntersectMBO/ouroboros-consensus#8.

Checklist

  • Branch
    • Commit sequence broadly makes sense
    • Commits have useful messages
    • The documentation has been properly updated
    • New tests are added if needed and existing tests are updated
    • Any changes affecting Consensus packages must have an entry in the appropriate changelog.d directory created using scriv. If in doubt, see the Consensus release process.
    • If this branch changes Network and has any consequences for downstream repositories or end users, said changes must be documented in interface-CHANGELOG.md
    • If serialization changes, user-facing consequences (e.g. replay from genesis) are confirmed to be intentional.
  • Pull Request
    • Self-reviewed the diff
    • Useful pull request description at least containing the following information:
      • What does this PR change?
      • Why these changes were needed?
      • How does this affect downstream repositories and/or end-users?
      • Which ticket does this PR close (if any)? If it does, is it linked?
    • Reviewer requested

@dnadales dnadales force-pushed the 4185-remove-consensus-docs branch from 7772875 to 1bde776 Compare February 16, 2023 12:28
@dnadales dnadales marked this pull request as ready for review February 16, 2023 12:29
@dnadales dnadales requested review from amesgen, a user, bartfrenk, jasagredo and jorisdral and removed request for bolt12 February 16, 2023 12:30
jorisdral
jorisdral requested changes Feb 16, 2023
View reviewed changes
Copy link
Contributor

@jorisdral jorisdral left a comment

Choose a reason for hiding this comment

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

The greatest diff statistics I've ever seen ;)

image

cabal.project
@@ -31,6 +31,7 @@ packages: ./cardano-ping
./ouroboros-network-protocols
./ouroboros-network-testing
./ouroboros-consensus
./ouroboros-consensus-tutorials
Copy link
Contributor

Choose a reason for hiding this comment

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

The tutorials were already included in ouroboros-consensus:tutorials, which now fails to build -- we should probably remove the sublib from ouroboros-consensus

Copy link
Member Author

Choose a reason for hiding this comment

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

Ups, indeed.

@dnadales dnadales force-pushed the 4185-remove-consensus-docs branch from 1bde776 to 0fe4983 Compare February 16, 2023 14:26
@dnadales dnadales mentioned this pull request Feb 16, 2023
Merged
jorisdral
jorisdral approved these changes Feb 16, 2023
View reviewed changes
Copy link
Contributor

@jorisdral jorisdral left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM

Last thing we should check before merging is whether we need to update the release process, since we have added a new consensus package. Do we want to publish it or should it stay local?

@dnadales
Copy link
Member Author

LGTM

Last thing we should check before merging is whether we need to update the release process, since we have added a new consensus package. Do we want to publish it or should it stay local?

Good point. I'd say for now it should stay local. I think the tutorials should be part of the ouroboros-consensus bundle (since they aren't Cardano specific). I don't know which is the best place to mention this though.

@jorisdral
Copy link
Contributor

LGTM
Last thing we should check before merging is whether we need to update the release process, since we have added a new consensus package. Do we want to publish it or should it stay local?

Good point. I'd say for now it should stay local. I think the tutorials should be part of the ouroboros-consensus bundle (since they aren't Cardano specific). I don't know which is the best place to mention this though.

I think https://github.com/input-output-hk/ouroboros-network/blob/master/Consensus-CHANGELOG.md could be a good place to mention it

@dnadales
Copy link
Member Author

I think https://github.com/input-output-hk/ouroboros-network/blob/master/Consensus-CHANGELOG.md could be a good place to mention it

Hmm, the thing is that we do not mention which package belong to which bundle in that file.

@dnadales
Copy link
Member Author

bors r+

iohk-bors bot added a commit that referenced this pull request Feb 24, 2023
@iohk-bors @dnadales
Merge #4374
8840c4a 
4374: 4185 remove consensus docs r=dnadales a=dnadales

The documentation for Consensus will be now hosted at https://github.com/input-output-hk/ouroboros-consensus/ This is the first step towards migrating the Consensus implementation to this repository.

Part of #4145, and complemented by IntersectMBO/ouroboros-consensus#8.



Co-authored-by: Damian Nadales <damian.only@gmail.com>
@iohk-bors
Copy link
Contributor

iohk-bors bot commented Feb 24, 2023

Build failed:

@dnadales dnadales force-pushed the 4185-remove-consensus-docs branch from 0fe4983 to ac60bf2 Compare February 24, 2023 11:57
@dnadales
Copy link
Member Author

bors r+

iohk-bors bot added a commit that referenced this pull request Feb 24, 2023
@iohk-bors @dnadales
Merge #4374
f6d4fb9 
4374: 4185 remove consensus docs r=dnadales a=dnadales

The documentation for Consensus will be now hosted at https://github.com/input-output-hk/ouroboros-consensus/ This is the first step towards migrating the Consensus implementation to this repository.

Part of #4145, and complemented by IntersectMBO/ouroboros-consensus#8.



Co-authored-by: Damian Nadales <damian.only@gmail.com>
@iohk-bors
Copy link
Contributor

iohk-bors bot commented Feb 24, 2023

Build failed:

@dnadales
Move the tutorials to a new directory
f59a686 
Since directory `ouroboros-consensus/docs` will be removed later on, the
tutorials are now placed on a separated directory.
@dnadales
Delete the docs folder
e37fbed 
These files have been moved to the `ouroboros-consensus` repository. See https://github.com/input-output-hk/ouroboros-consensus/
@dnadales dnadales force-pushed the 4185-remove-consensus-docs branch from ac60bf2 to e37fbed Compare February 24, 2023 14:04
@dnadales
Copy link
Member Author

bors r+

@iohk-bors
Copy link
Contributor

iohk-bors bot commented Feb 24, 2023

Build succeeded:

@iohk-bors iohk-bors bot merged commit 1d45c7e into master Feb 24, 2023
@iohk-bors iohk-bors bot deleted the 4185-remove-consensus-docs branch February 24, 2023 18:16
@jasagredo jasagredo mentioned this pull request Mar 9, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jorisdral jorisdral jorisdral approved these changes

@nfrisby nfrisby Awaiting requested review from nfrisby

@coot coot Awaiting requested review from coot

@amesgen amesgen Awaiting requested review from amesgen

@bartfrenk bartfrenk Awaiting requested review from bartfrenk

@jasagredo jasagredo Awaiting requested review from jasagredo

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

Successfully merging this pull request may close these issues.
2 participants
@dnadales @jorisdral