Skip to content

Conversation

@pochoi
Copy link
Contributor

@pochoi pochoi commented Feb 23, 2021

relative paths for contribution docs

Description

The links of code of conduct and contributing guidelines are in absolute path https://github.com/uber/orbit/blob/master/ which does not contain the docs.

The links should be relative paths so that the links work in GitHub README.md homepage in every branch.
I replaced them with relative paths as described in GitHub Docs About READMEs.

Type of change

  • [✅] Bug fix

How Has This Been Tested?

Created a branch with the relative links and push it into GitHub. Went to the README.md homepage and click the links! For example, my branch for the pull request pochoi-contr-links.

relative paths for contribution docs
@CLAassistant
Copy link

CLAassistant commented Feb 23, 2021

CLA assistant check
All committers have signed the CLA.

@edwinnglabs
Copy link
Collaborator

I was doing full path due to deployment on PyPI (the README will be directly duplicate there) and assuming the README file eventually merge with master (hence the master path)..in fact we could do a dev branch path as well.

@edwinnglabs edwinnglabs self-requested a review February 24, 2021 22:08
Copy link
Collaborator

@edwinnglabs edwinnglabs left a comment

Choose a reason for hiding this comment

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

LGTM

@edwinnglabs edwinnglabs merged commit c5feba1 into uber:dev Feb 24, 2021
@pochoi
Copy link
Contributor Author

pochoi commented Feb 25, 2021

Thank you so much!

edwinnglabs pushed a commit that referenced this pull request Feb 27, 2021
* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>
edwinnglabs pushed a commit that referenced this pull request Feb 27, 2021
* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>
edwinnglabs pushed a commit that referenced this pull request Mar 3, 2021
* add changelogs

* fix conflict

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* rebase  and refine of docs

* rebasE

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* Update README.md

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* rebase  and refine of docs

* rebasE

Co-authored-by: Edwin Ng <edwinng@uber.com>
Co-authored-by: Chi Po Choi <cpchoi@ucdavis.edu>
Co-authored-by: Zhishi Wang <zhishiw@uber.com>
vincewu51 pushed a commit that referenced this pull request Mar 24, 2021
* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>
vincewu51 pushed a commit that referenced this pull request Mar 24, 2021
* add changelogs

* fix conflict

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* rebase  and refine of docs

* rebasE

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* Update README.md

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* rebase  and refine of docs

* rebasE

Co-authored-by: Edwin Ng <edwinng@uber.com>
Co-authored-by: Chi Po Choi <cpchoi@ucdavis.edu>
Co-authored-by: Zhishi Wang <zhishiw@uber.com>
edwinnglabs pushed a commit that referenced this pull request Mar 27, 2021
* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>
edwinnglabs pushed a commit that referenced this pull request Mar 27, 2021
* add changelogs

* fix conflict

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* rebase  and refine of docs

* rebasE

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* Update README.md

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* rebase  and refine of docs

* rebasE

Co-authored-by: Edwin Ng <edwinng@uber.com>
Co-authored-by: Chi Po Choi <cpchoi@ucdavis.edu>
Co-authored-by: Zhishi Wang <zhishiw@uber.com>
wangzhishi added a commit that referenced this pull request Apr 2, 2021
* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>
wangzhishi added a commit that referenced this pull request Apr 2, 2021
* add changelogs

* fix conflict

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* rebase  and refine of docs

* rebasE

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* Update README.md

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* rebase  and refine of docs

* rebasE

Co-authored-by: Edwin Ng <edwinng@uber.com>
Co-authored-by: Chi Po Choi <cpchoi@ucdavis.edu>
Co-authored-by: Zhishi Wang <zhishiw@uber.com>
wangzhishi added a commit that referenced this pull request Apr 2, 2021
wangzhishi added a commit that referenced this pull request Apr 2, 2021
* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>
wangzhishi added a commit that referenced this pull request Apr 2, 2021
* add changelogs

* fix conflict

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* rebase  and refine of docs

* rebasE

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* Update README.md (#370)

* Update README.md

relative paths for contribution docs

* change link to dev

Co-authored-by: Zhishi Wang <zhishiw@uber.com>

* Update README.md

* Some documentation change (#367)

* Update README.md

* Create orbit-banner640x320.png

* Update RELEASE.md

* Update setup.py

* updating a few admin docs

- code of conduct
- contributing
- release

* Update README.md

* Update README.md

* rebase  and refine of docs

* rebasE

Co-authored-by: Edwin Ng <edwinng@uber.com>
Co-authored-by: Chi Po Choi <cpchoi@ucdavis.edu>
Co-authored-by: Zhishi Wang <zhishiw@uber.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