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

Source code for new tutorial #3316

Closed
chrislovecnm opened this issue Oct 10, 2022 · 5 comments · Fixed by #3317
Closed

Source code for new tutorial #3316

chrislovecnm opened this issue Oct 10, 2022 · 5 comments · Fixed by #3317

Comments

@chrislovecnm
Copy link
Contributor

Hi all

We wrote a new rules_go tutorial under the purview of the Bazel Rules sig. The tutorial is located on the bazel rules GitHub pages site. Along with that tutorial, we have source code that needs a home. Talking with @alexeagle, we were wondering if we could include the tutorial source code in this repo.

Here is the source code:

bazel-contrib/Bazel-learning-paths#6

We would rather not have the source in Bazel-learning-paths.

Thanks
Chris

@fmeum
Copy link
Collaborator

fmeum commented Oct 10, 2022

Great content that I would be happy to have in this repo. We don't have a top-level example(s) directory yet, so I think that would be a natural place to have it in.

Do you want to submit a PR? I would then review the examples.

@chrislovecnm
Copy link
Contributor Author

@fmeum what is the full directory path that we want? I will need to update both the source code and the tutorial.

rules_go/examples/tutorial - how about that?

@chrislovecnm
Copy link
Contributor Author

And yes I am happy to do a PR

@fmeum
Copy link
Collaborator

fmeum commented Oct 10, 2022

That sounds reasonable, we might want to add other examples in the future that aren't linked to the tutorial.

Where is the tutorial itself hosted? Would it make sense to also host it in the rules_go repo so that tutorial and accompanying code are easier to keep in sync?

@chrislovecnm
Copy link
Contributor Author

@fmeum, the tutorial is here: https://bazel-contrib.github.io/SIG-rules-authors/go-tutorial.html - and eventually, we are trying to figure out how to move it to https://bazel.build/start/.

I wish it were easier to keep the tutorial and source code in sync, but we want the tutorial hosted on a website, and for now, the bazel-contrib gh-pages is our best option.

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.

2 participants