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

Remove Idemixgen from Fabric produced binaries #4834

Merged
merged 2 commits into from May 15, 2024

Conversation

Sayalikukkar
Copy link
Contributor

@Sayalikukkar Sayalikukkar commented May 3, 2024

Type of change

  • Documentation update

Description

Removed Idemixgen from the documentation to reflect its removal from the set of Fabric produced binaries. Also created the seperate PR for idemix repo.

Additional details

Related issues

Closes #3575

@Sayalikukkar Sayalikukkar requested review from a team as code owners May 3, 2024 14:14
@denyeart
Copy link
Contributor

denyeart commented May 4, 2024

Thank you for the update.

There is also a link to this document in a table of contents that needs to be removed at the same time - https://raw.githubusercontent.com/hyperledger/fabric/main/docs/source/ops_guide.rst

Also https://github.com/hyperledger/fabric/blob/main/docs/source/idemix.rst mentions that Fabric provides this tool. I think we'd want to update that wording from "Fabric provides two possible Idemix issuers" to "There are two possible Idemix issuers". And make "idemix tool" a hyperlink over to https://github.com/IBM/idemix.

Finally, I think we'd want this doc content to appear at https://github.com/IBM/idemix where the tool now resides, before removing it from Fabric docs, do you want to submit the PR to https://github.com/IBM/idemix as well to complete the move?

@Sayalikukkar
Copy link
Contributor Author

Sayalikukkar commented May 4, 2024

@denyeart , Sure, I'm interested in helping with that. I can make the necessary updates to the Fabric documentation as you've described and also submit a pull request to the IBM idemix repository to ensure the content is properly moved.

@Sayalikukkar Sayalikukkar reopened this May 4, 2024
Signed-off-by: sayalikukkar <sayukukkar11@gmail.com>
@denyeart
Copy link
Contributor

denyeart commented May 9, 2024

Thank you, looks good to me now.
But let's wait for @ale-linux to merge IBM/idemix#41 to ensure we have the doc somewhere.

@Sayalikukkar
Copy link
Contributor Author

Thank you for your feedback and guidance!


a) Fabric CA for production environments or development, and
b) the :doc:`idemixgen <idemixgen>` tool for development environments.
b) the `idemix <https://github.com/IBM/idemix>`_ tool for development environments.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
b) the `idemix <https://github.com/IBM/idemix>`_ tool for development environments.
b) the `idemixgen <https://github.com/IBM/idemix/blob/main/tools/idemixgen/idemixgen.rst>`_ tool for development environments.

Ok, the idemixgen tool doc was merged into the idemix repository, so let's point directly to that now.

Copy link
Contributor

@denyeart denyeart left a comment

Choose a reason for hiding this comment

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

Thank you for the quick responses, looks good now!

@denyeart
Copy link
Contributor

Sorry, there is now a conflict in the doc, I think in the ops_guide table of contents. Could you resolve the conflict by rebasing locally and then re-push?

Also, it would be nice to squash the 3 commits into a single commit, see guidance at https://hyperledger-fabric.readthedocs.io/en/latest/github/github.html#updating-a-pull-request.

Signed-off-by: sayalikukkar <sayukukkar11@gmail.com>

Remove Idemixgen from Fabric produced binaries

Signed-off-by: sayalikukkar <sayukukkar11@gmail.com>

Remove Idemixgen from Fabric produced binaries

Signed-off-by: sayalikukkar <sayukukkar11@gmail.com>
@denyeart
Copy link
Contributor

Perfect, thank you!

@denyeart denyeart merged commit fe7c46a into hyperledger:main May 15, 2024
13 of 14 checks passed
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.

Idemixgen was removed from the set of Fabric produced binaries but is still mentioned in ReadTheDocs
2 participants