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

docs: repo_token => REPO_TOKEN #492

Merged
merged 1 commit into from
May 10, 2021
Merged

docs: repo_token => REPO_TOKEN #492

merged 1 commit into from
May 10, 2021

Conversation

casperdcl
Copy link
Contributor

Follow-up to #489

@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Apr 30, 2021

Please note that we currently have our documentation spread over a few places; you may also want to update https://cml.dev (source) and https://dvc.org/doc/cml (source).

clippy

@casperdcl
Copy link
Contributor Author

casperdcl commented Apr 30, 2021

Wait what.

https://dvc.org/doc/cml is just a mirror of this repo's README. Much duplication such inefficient. @jorgeorpinel @shcheklein any better suggestions? I'd really rather prefer dvc.org/doc/cml to be a one page blurb containing links to this repo & cml.dev

@casperdcl casperdcl self-assigned this Apr 30, 2021
@casperdcl casperdcl added the documentation Markdown files label Apr 30, 2021
@0x2b3bfa0
Copy link
Member

I'm inclined to think that it would be better to keep documentation in a single place (preferably cml.dev) and point to it from both dvc.org/doc/cml and the README.md file.

@0x2b3bfa0 0x2b3bfa0 self-requested a review May 1, 2021 16:06
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

https://dvc.org/doc/cml is just a mirror of this repo's README. Much duplication such inefficient. @jorgeorpinel @shcheklein any better suggestions? I'd really rather prefer dvc.org/doc/cml to be a one page blurb containing links to this repo & cml.dev

Yeah I think the README existed first and was the main documentation. At some point we needed to publish CML docs somewhere formal for some reason so it was copied over. Definitely should not have the same content. The Q is what's the vocation of each one? README vs CML docs (home page), that is.

Same Q applies for DVC BTW... @casperdcl do you want to make an issue about the product READMEs in the docs repo?

@casperdcl
Copy link
Contributor Author

Sure @jorgeorpinel I just opened iterative/dvc.org#2443 which is going to be fun :)

@casperdcl casperdcl mentioned this pull request May 5, 2021
2 tasks
@casperdcl casperdcl closed this in 44b797e May 10, 2021
@casperdcl casperdcl merged commit 44b797e into master May 10, 2021
@0x2b3bfa0 0x2b3bfa0 deleted the docs-token branch May 10, 2021 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Markdown files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants