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

Add the article for Aurora's dev portal #1

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add the article for Aurora's dev portal #1

wants to merge 7 commits into from

Conversation

mooori
Copy link
Owner

@mooori mooori commented Nov 29, 2023

This is my proposal for the article to be published on https://dev.aurora.dev.

Article.md Outdated Show resolved Hide resolved
Copy link

@akhi3030 akhi3030 left a comment

Choose a reason for hiding this comment

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

LGTM! Mainly minor comments. Feel free to ignore any. Thanks for writing this up.

Article.md Outdated
}
```

*The final version of the code is available [in this repository on github](https://github.com/mooori/counter-acl-example). The `Counter` example is inspired by [near-examples/counter-rust](https://github.com/near-examples/counter-rust).*
Copy link

Choose a reason for hiding this comment

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

nit: Will this repo live in your personal github account or do you plan on eventually transferring it to the near or aurora or some other org? I am asking as we may need to update the link here. I wonder if it is possible to use relative paths here instead so this question is mute.

Copy link
Owner Author

Choose a reason for hiding this comment

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

Made the links relative in 1582d56.

I’ve created the repo in my personal github as I wasn’t sure were it should live, to avoid triggering some workflows in a potentially wrong org. Moving it to an org is fine for me. Especially if this should be an official example/reference moving it to an org would make sense.

Copy link

Choose a reason for hiding this comment

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

Thanks. I think we can keep it here for now and figure out eventually which org to place it in. Longer term, it should probably be in some org.

Article.md Outdated Show resolved Hide resolved
Article.md Outdated Show resolved Hide resolved
Article.md Outdated
# Add `near-plugins` under `dependencies` in your Cargo.toml.

[dependencies]
near-plugins = { git = "https://github.com/aurora-is-near/near-plugins.git", rev = "102d95b" }
Copy link

Choose a reason for hiding this comment

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

Do we need to specify a rev? That might mean that people could miss bugfixes, etc. easily. I suppose this would be resolved when we have released the crate. Maybe in the mean time, we can use tags? I am afraid of too many people hardcoding a specific revision in their repo and then forgetting to update.

Copy link
Owner Author

Choose a reason for hiding this comment

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

I agree that this would be resolved when the crate is released and becomes a “regular” dependency. Unless we manually move the tag as near-plugins is changed, I think it would basically be the same: a reference to a commit.

Still, using a tag to the latest release helps explaining why that particular commit is used. It’s about time to release a new version of near-plugins. I’ll look into that and then replace the rev here with a tag to the new version.

Copy link

Choose a reason for hiding this comment

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

Perfect, thanks, that makes sense.

Copy link
Owner Author

Choose a reason for hiding this comment

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

The new release of near-plugins has been published. This repo now specifies the near-plugins dependency with tag = "v0.2.0" (cc1c75e).

Article.md Show resolved Hide resolved
Article.md Outdated Show resolved Hide resolved
@mooori mooori requested a review from akhi3030 December 6, 2023 21:52
Copy link

@akhi3030 akhi3030 left a comment

Choose a reason for hiding this comment

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

Changes look great!

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