Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Docs for v1 missing #411

Closed
derwaldgeist opened this issue Oct 31, 2024 · 3 comments
Closed

Docs for v1 missing #411

derwaldgeist opened this issue Oct 31, 2024 · 3 comments
Labels

Comments

@derwaldgeist
Copy link

derwaldgeist commented Oct 31, 2024

We're still on v1 of this package in our Meteor 2 application and I wanted to lookup the docs for this version. Unfortunately, the docs links on this page are broken:

https://github.com/Meteor-Community-Packages/meteor-roles/tree/v1

It would be nice if the latest docs would at least state which method is available in from which version on.

It also seems as if the syntax of getUsersInRole() has changed.

Copy link

Thank you for submitting this issue!

We, the Members of Meteor Community Packages take every issue seriously.
Our goal is to provide long-term lifecycles for packages and keep up
with the newest changes in Meteor and the overall NodeJs/JavaScript ecosystem.

However, we contribute to these packages mostly in our free time.
Therefore, we can't guarantee your issues to be solved within certain time.

If you think this issue is trivial to solve, don't hesitate to submit
a pull request, too! We will accompany you in the process with reviews and hints
on how to get development set up.

Please also consider sponsoring the maintainers of the package.
If you don't know who is currently maintaining this package, just leave a comment
and we'll let you know

@alanning
Copy link
Contributor

Hi @derwaldgeist , sorry for the trouble. It looks like github deleted my Github Pages where the docs were hosted.

The good news is that you can still view them locally. I have updated the API Docs section to point to the current YUIDoc project page: https://yui.github.io/yuidoc/

Here are the relevant steps to generate and view the docs locally:

To re-generate documentation:

install YUIDoc
cd meteor-roles
yuidoc

To serve documentation locally:

install YUIDoc
cd meteor-roles
yuidoc --server
point browser at http://localhost:3000/

@derwaldgeist
Copy link
Author

derwaldgeist commented Nov 1, 2024

Thanks for the super fast response! And thanks for the great work.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants