-
Notifications
You must be signed in to change notification settings - Fork 516
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
Reorganize the ACA-Py Documentation Files #2765
Conversation
Signed-off-by: Stephen Curran <[email protected]>
Not good that we have an integration test error when moving docs :-). The error is from this test: Not sure if it is a timing issue or something else. Seems to be finding duplicate records. Perhaps someone could run this locally. It is related to the Endorser, so perhaps updates in that area? |
I'm pretty sure this is an intermittently failing test, as other tests off of main are passing and I think I've seen it before. Re-running. If it fails again I'll look at it locally. |
Signed-off-by: Stephen Curran <[email protected]>
Quality Gate passedIssues Measures |
Turned on the VSCode link checker (who knew that wouldn't be on automatically!) and did a pass through all of the MDs again -- cleaned up links and all MD lint issues. Only thing left are the a few bare URLs (email addressess...) and the unlnown words that would be expected. I think that clean up is now done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Truthfully, I didn't read through every change but I'll rely on @jamshale's more in depth review and the linting to catch issues with links and such.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Meant to hit approve...
I've noticed the occasional timing issue with the ledger. I.e. the test registers a DID and then when it tries to record a schema it get an error that the DID isn't approved to update the ledger. I think it's a node synchronization timing issue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good. (Like Daniel I didn't read through every single document.) My preference would be to leave the demo docs in the /demo
folder, but I don't have a strong opinion about it.
I can’t believe y’all didn’t read every change in every file!!! IMHO, we want to encourage people to use https://aca-py.org, so having a redirector page in the /demo folder is the right thing to do. Understand your concerns, but at least they are all in one place — /docs/demo. Thanks for the reviews! |
This PR does a radical reorganization of the documents in the ACA-Py repository. The following is a summary of the changes:
demo
folder were moved to `docs/demo' and a new README.md file added pointing to those.docs/gettingStarted
folders.docs
folder with pointers to guidance for maintaining both the ReadTheDocs documentation and the https://aca-py.org documentation.Not perfect, but I think it is close.
It is a lot of change. Would appreciate people browsing my branch in the GitHub UI to scan for issues, and report them. Important things to note are changes that need to be made before we merge this and more general updates that are overdue and needed.