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

Update Readme with new links, and updated commands for running the demo #7989

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

toliaqat
Copy link
Contributor

refs: #7988

Description

  • Fix broken links of the agoric website documentation
  • Fix commands to run cosmic-swingset demo
  • Add links to tutorials and relevant repositories
  • Add health check badge at the top of root readme

Security Considerations

None

Scaling Considerations

None

Documentation Considerations

This

Testing Considerations

Verified the links and ran the commands being updated.

@toliaqat toliaqat requested a review from dckc June 28, 2023 17:07
Comment on lines -11 to +12
[follow our instructions for getting started](https://agoric.com/documentation/getting-started/)
[follow our instructions for getting started](https://docs.agoric.com/guides/getting-started/)
Copy link
Member

Choose a reason for hiding this comment

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

@Tyrosine22 let's please fix these links on the other end too with a redirect. Who knows how many other links there are to the old URL. (IOU an issue in the docs repo)

Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

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

thanks for tidying this up.

I think the Agoric Tutorials section goes a bit too far, though.


You can start other solo nodes with `make scenario2-run-client BASE_PORT=8001 SOLO_OTEL_EXPORTER_PROMETHEUS_PORT=9466` and `make scenario2-run-client BASE_PORT=8002 SOLO_OTEL_EXPORTER_PROMETHEUS_PORT=9467` and communicate with them respectively with on http://localhost:8001/ (`agoric open --hostport 127.0.0.1:8001`) and http://localhost:8002/ (`agoric open --hostport 127.0.0.1:8002`)
Copy link
Member

Choose a reason for hiding this comment

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

I wonder why SOLO_OTEL_EXPORTER_PROMETHEUS_PORT is required here. I suppose the default port will be already used if one doesn't override it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently, the default port is fixed and when we run multiple instances (following this instruction) then that default port start to conflict with the first process. I now think the better fix will be to not have prometheus run by default so that we have not port conflict and simple commands to run here.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, if we can leave prometheus out altogether, that seems much better.

Comment on lines +160 to +164
# Agoric tutorials

* [Chainboard Academy Bootcamp Lectures](https://www.youtube.com/watch?v=wWQxJnmZttE&list=PLZUbmHar_o80AEV_JjoxLZwxFIc-8uQAq) - [Lecture notes](https://github.com/Chainboard-Academy/agoric-lecture-content)
* [Agoric Tech Talks](https://www.youtube.com/watch?v=iyuo0ymTt4g&list=PLhuBigpl7lqth_Ow_eQWZs7NFxmeDw9W8)
* [Agoric Patterns](https://ilyasmercan.github.io/AgoricPatterns/)
Copy link
Member

Choose a reason for hiding this comment

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

The chainboard academy and Agoric Patterns are 3rd-party materials. While they're very nice, I don't think we should cite them as "Agoric Tutorials". Maybe move them to a wiki page and/or a discussion?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A renaming of "Agoric Tutorials" to just "Tutorials" ? The third link is also an external partner's link. I thought these and others similar links in future will be good place to add here for anyone to learn more from different angles. Any other suggestion for the heading or should I just remove these external links?

Copy link
Member

Choose a reason for hiding this comment

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

"Tutorials" would be enough to address my critical concern. Oh... also, add "by Ilyas Mercan" to the last one to distinguish its authorship from "Agoric Tech Talks".

But by way of suggestion/preference, I don't think they're all tutorials. How about "Learning Resources"?

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.

2 participants