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 contribute page about CI #9906

Merged
merged 4 commits into from
Jan 19, 2022
Merged

Add contribute page about CI #9906

merged 4 commits into from
Jan 19, 2022

Conversation

driazati
Copy link
Member

@driazati driazati commented Jan 12, 2022

This adds some docs with a description of the TVM CI and some usage instructions to both make contributing more friendly and educate existing developers about how CI runs. Bikeshedding on content is welcome

cc @areusch @konturn

@driazati driazati force-pushed the ci_docs branch 2 times, most recently from a0cd355 to c589e2c Compare January 12, 2022 00:09
Copy link
Contributor

@electriclilies electriclilies left a comment

Choose a reason for hiding this comment

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

This is awesome, thanks! I think adding a few details about building TVM once you're in the docker container would be helpful (left details inline). Looking forward to this going in!

docs/contribute/ci.rst Outdated Show resolved Hide resolved
docs/contribute/ci.rst Outdated Show resolved Hide resolved
docs/contribute/ci.rst Outdated Show resolved Hide resolved
*************

.. |top_of_the_Jenkinsfile| replace:: top of the ``Jenkinsfile``
.. _top_of_the_Jenkinsfile: https://github.com/apache/tvm/blob/7481a297740f073b193a3f09b3e27f056e8c7f2e/Jenkinsfile#L48-L54
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it would be simpler here to reproduce a snippet of the Jenkins file, rather than link to a specific git hash.

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't want to run the risk of this being out of date with no context, if the Jenkinsfile changes at some point this way there is at least an obvious trail (i.e. the linked commit is too old) rather than a code snippet which is much harder to track down and see when/why it changed

driazati added a commit to driazati/web-data-1 that referenced this pull request Jan 14, 2022
areusch pushed a commit to tlc-pack/web-data that referenced this pull request Jan 14, 2022
Co-authored-by: driazati <driazati@users.noreply.github.com>
This adds some docs with a description of the TVM CI and some usage instructions to both make contributing more friendly and educate existing developers about how CI runs. Bikeshedding on content is welcome

Note: The TODOs are blocked on some other PRs and will be done before landing
@jroesch
Copy link
Member

jroesch commented Jan 19, 2022

Thanks for the feedback everyone, feel free to send a PR or message David for further follow up work.

@jroesch jroesch merged commit 1351ede into apache:main Jan 19, 2022
@Hzfengsy Hzfengsy mentioned this pull request Jan 20, 2022
yuanfz98 pushed a commit to yuanfz98/tvm that referenced this pull request Jan 24, 2022
* Add contribute page about CI

This adds some docs with a description of the TVM CI and some usage instructions to both make contributing more friendly and educate existing developers about how CI runs. Bikeshedding on content is welcome

Note: The TODOs are blocked on some other PRs and will be done before landing

* docker instructions

* Comments

* Rebase

Co-authored-by: driazati <driazati@users.noreply.github.com>
crazydemo pushed a commit to crazydemo/tvm that referenced this pull request Jan 27, 2022
* Add contribute page about CI

This adds some docs with a description of the TVM CI and some usage instructions to both make contributing more friendly and educate existing developers about how CI runs. Bikeshedding on content is welcome

Note: The TODOs are blocked on some other PRs and will be done before landing

* docker instructions

* Comments

* Rebase

Co-authored-by: driazati <driazati@users.noreply.github.com>
ylc pushed a commit to ylc/tvm that referenced this pull request Feb 16, 2022
* Add contribute page about CI

This adds some docs with a description of the TVM CI and some usage instructions to both make contributing more friendly and educate existing developers about how CI runs. Bikeshedding on content is welcome

Note: The TODOs are blocked on some other PRs and will be done before landing

* docker instructions

* Comments

* Rebase

Co-authored-by: driazati <driazati@users.noreply.github.com>
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.

4 participants