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

docs(whitepaper): renovate or temporarily remove whitepaper #2691

Open
RafaelAPB opened this issue Sep 15, 2023 · 9 comments
Open

docs(whitepaper): renovate or temporarily remove whitepaper #2691

RafaelAPB opened this issue Sep 15, 2023 · 9 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@RafaelAPB
Copy link
Contributor

Our whitepaper is around two years old and no longer reflects the project's current state. I'd like to suggest some coordination amongst maintainers and contributors of Cacti to update the whitepaper. While not a core distinguished of our project, I believe we should make this a priority, not only to provide better visibility of our project but also to document the rationale behind our project.

cc @petermetz

@RafaelAPB RafaelAPB added the enhancement New feature or request label Sep 15, 2023
@petermetz petermetz added the documentation Improvements or additions to documentation label Sep 17, 2023
@petermetz petermetz changed the title Update whitepaper docs(whitepaper): renovate or temporarily remove whitepaper Sep 17, 2023
@petermetz petermetz added this to the v2.0.0 milestone Sep 17, 2023
@petermetz
Copy link
Contributor

@RafaelAPB I agree! With the v2.0.0 release coming up and the workshop in November being so close as well, I can't volunteer any of my time for the whitepaper renovation unfortunately.
If anyone else has the time to do it, great, but if no one does, then I'd suggest that we just remove it for now so that it does not confuse people (confusing documentation is worse than not having as much documentation to begin with)

@RafaelAPB
Copy link
Contributor Author

Agreed @petermetz - let's do it after this next release.

@petermetz petermetz self-assigned this Sep 17, 2023
petermetz added a commit to petermetz/cacti that referenced this issue Sep 17, 2023
1. Removes all the contents except for the document title
2. Updates the version to v2.0
3. Updates the Hyperledger Foundation logo to the current latest as of 2023
4. Adds a disclaimer about the fact that the whitepaper is
being re-worked and where to find the old version.

Related to, but does not conclude the work of hyperledger-cacti#2691

[skip-ci]

Signed-off-by: Peter Somogyvari <[email protected]>
@petermetz
Copy link
Contributor

Agreed @petermetz - let's do it after this next release.

@RafaelAPB FYI: I sent this in the meantime: https://github.com/hyperledger/cacti/pull/2699

petermetz added a commit to petermetz/cacti that referenced this issue Sep 29, 2023
1. Removes all the contents except for the document title
2. Updates the version to v2.0
3. Updates the Hyperledger Foundation logo to the current latest as of 2023
4. Adds a disclaimer about the fact that the whitepaper is
being re-worked and where to find the old version.

Related to, but does not conclude the work of hyperledger-cacti#2691

[skip-ci]

Signed-off-by: Peter Somogyvari <[email protected]>
petermetz added a commit that referenced this issue Sep 29, 2023
1. Removes all the contents except for the document title
2. Updates the version to v2.0
3. Updates the Hyperledger Foundation logo to the current latest as of 2023
4. Adds a disclaimer about the fact that the whitepaper is
being re-worked and where to find the old version.

Related to, but does not conclude the work of #2691

[skip-ci]

Signed-off-by: Peter Somogyvari <[email protected]>
@VRamakrishna
Copy link
Contributor

@petermetz @RafaelAPB I can help in this task, though like you both, it's going to be tough to extract too many cycles for it from my schedule.

I am currently refactoring the integrated documentation (legacy Cactus + legacy Weaver) and publishing a MkDocs version, the PR for which I will submit in the next few days. Based on what the integrated docs contain, I can (at some point in October), propose a new whitepaper outline (i.e., table of contents). We can then discuss it and then divide the tasks among ourselves.

I think we ought to schedule dedicated meetings on the Cacti calendar to brainstorm the details, though (fair warning) I'll be out of action for a good chunk of November and December.

@VRamakrishna
Copy link
Contributor

For your reference, here is the documentation PR I just opened: https://github.com/hyperledger/cacti/pull/2726.

@RafaelAPB
Copy link
Contributor Author

Let us discuss this through the proposed schedule. Thank you for your input @VRamakrishna.

@petermetz
Copy link
Contributor

@petermetz @RafaelAPB I can help in this task, though like you both, it's going to be tough to extract too many cycles for it from my schedule.

I am currently refactoring the integrated documentation (legacy Cactus + legacy Weaver) and publishing a MkDocs version, the PR for which I will submit in the next few days. Based on what the integrated docs contain, I can (at some point in October), propose a new whitepaper outline (i.e., table of contents). We can then discuss it and then divide the tasks among ourselves.

I think we ought to schedule dedicated meetings on the Cacti calendar to brainstorm the details, though (fair warning) I'll be out of action for a good chunk of November and December.

Thank you @VRamakrishna I agree that we could add the whitepaper to the maintainer meeting agenda, but until the workshop is finished I definitely won't be able to work on it unfortunately (maybe some parts that are specific to the workshop that I'll be able to use there but probably not even that because first and foremost I want the code to work)

@RafaelAPB
Copy link
Contributor Author

Kindly let me know when we schedule a maintainers meeting to address this.

@petermetz
Copy link
Contributor

Kindly let me know when we schedule a maintainers meeting to address this.

@RafaelAPB For me, the best would be in December!

sandeepnRES pushed a commit to sandeepnRES/cacti that referenced this issue Dec 21, 2023
1. Removes all the contents except for the document title
2. Updates the version to v2.0
3. Updates the Hyperledger Foundation logo to the current latest as of 2023
4. Adds a disclaimer about the fact that the whitepaper is
being re-worked and where to find the old version.

Related to, but does not conclude the work of hyperledger-cacti#2691

[skip-ci]

Signed-off-by: Peter Somogyvari <[email protected]>
@petermetz petermetz removed this from the v2.0.0 milestone Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants