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

[Documentation]: Some cookbook examples are out-of-date. #923

Closed
grootpiano opened this issue Feb 6, 2023 · 0 comments · Fixed by #924
Closed

[Documentation]: Some cookbook examples are out-of-date. #923

grootpiano opened this issue Feb 6, 2023 · 0 comments · Fixed by #924

Comments

@grootpiano
Copy link
Contributor

Describe the issue
Hi, I found some cookbook examples are out-of-date.

After we changed line pkg/api/member.go:76 from buff, err := yaml.Marshal(resp) to buff, err := codectool.MarshalJSON(resp), some grep commands in examples are not worked.

e.g. commands in Getting Started and Easegress cluster cookbook:

$ egctl member list | grep "cluster-role"   # should grep "ClusterRole"
$ egctl member list | grep "api-addr"
$ egctl member list | grep "name"
egctl --server $HOST1:2381 member list | grep " name"

Version
Latest master branch version 73d7dd32.

Additional context
I'm sure that everyone can fix this little tiny issue by themselves. But I also want to make our docs better, at least the
Getting Started part.


Thanks for contributing 🎉!

suchen-sci pushed a commit that referenced this issue Feb 9, 2023
* fix arguments typo in entrypoint.sh

* fix protocol typo

* fix jsonschema typo

* update api aggregation scenario 3 spec

* add -i option to grep for insensitive matching

* fix typo in Easegress cluster cookbook

* make cookbook examples up-to-date
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 a pull request may close this issue.

1 participant