-
Notifications
You must be signed in to change notification settings - Fork 1k
Conversation
ok so, we definitely want to do this 😄 i'll try for more review today or tomorrow, but in the meantime, do you think we could reasonably do some of those checkboxes in stages? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried it, works and looks great.
I've left a few inline comments about the broken links. But I feel, since there's a lot of text, we can fix them gradually later. Maybe get help from the readers?
At this stage, the maintainers are most interested in feedback centered on the user experience (UX) of the tool. | ||
Do you have workflows that the tool supports well, or doesn't support at all? | ||
Do any of the commands have surprising effects, output, or results? | ||
Please check the existing issues and [FAQ](docs/FAQ.md) to see if your feedback has already been reported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link seems to be broken. [FAQ](faq)
works.
- [User Stories](https://docs.google.com/document/d/1wT8e8wBHMrSRHY4UF_60GCgyWGqvYye4THvaDARPySs/edit) | ||
- [Features](https://docs.google.com/document/d/1JNP6DgSK-c6KqveIhQk-n_HAw3hsZkL-okoleM43NgA/edit) | ||
- [Design Space](https://docs.google.com/document/d/1TpQlQYovCoX9FkpgsoxzdvZplghudHAiQOame30A-v8/edit) | ||
- [Frequently Asked Questions](docs/FAQ.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/FAQ.md
-> faq
|
||
## Installing dependencies | ||
|
||
(if your `vendor/` directory isn't [checked in with your code](docs/FAQ.md#should-i-commit-my-vendor-directory)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/FAQ.md
-> /dep/faq#...
1. Back up your existing `vendor/` directory (if you have one) to | ||
`_vendor-TIMESTAMP/` | ||
1. Pick the highest compatible version for each dependency | ||
1. Generate [`Gopkg.toml`](docs/Gopkg.toml.md) ("manifest") and `Gopkg.lock` files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link would require docs/Gopkg.toml.md
to be moved into docs/content/
and then change the link accordingly. Or maybe an external github link to the file.
|
||
This does the following: | ||
|
||
1. Look for [existing dependency management files](docs/FAQ.md#what-external-tools-are-supported) to convert |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/FAQ.md
-> /dep/faq#...
Contributions are greatly appreciated. | ||
The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers. | ||
The project follows the typical GitHub pull request model. | ||
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link would require moving CONTRIBUTING.md
into docs/content/
. Or maybe an external github link would be good for it.
/docs/_deploy/ | ||
/docs/_preview/ | ||
/docs/config.toml.bak | ||
/hack/travis.deploy.pem |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
end with newline
@sdboyer Yeah, all the checkboxes can be done later, though if we want deploys to work, adding the deploy key to the repo is not optional. Everything else can be done later and I think we should. |
let's just get the deploy key in here, then. I'm not clear on what we need to do there, though - just enter it into Travis via their mechanism for secrets? |
@sdboyer On the repo, click Settings -> Deploy Keys -> Add Deploy Key, then paste the public key from my pull request (below). The private key has been encrypted with the travis tool for this repo only, and can only be decrypted during a travis build on master (i.e. not forks). https://github.com/golang/dep/pull/1369/files#diff-4792ccfc9d3ef656e9cb864451527ea5 |
Closing in favor of #1499 |
y'know i think actually we could probably set up docusaurus before the docs themselves are merged. just...not publicize it until it's got content there😁 |
@sdboyer Is that a hint? 😁 |
it was actually just musing, not a hint, sorry - though if you had time to take it as a hint, i would be the opposite of unhappy about it 😉 |
@sdboyer I'll trade you looking at my transitive constraints PR/proposal, in exchange for setting up docusaurus. |
What does this do / why do we need it?
This is a prototype for a dep doc site. You can see an example of it at https://carolynvs.github.io/depdocs/.
/docs
, and are versioned along with the dep code.gh-pages
branch. This branch should never be manually tweaked as changes will be lost on the next push.gh-pages
. PR builds do not have access to this, it's only decrypted for merged code.Before we merge this the following should occur. I'll do this on this PR after we are sure we want to accept this PR:
What should your reviewer look out for in this PR?
What is not in scope?
Do you need help or clarification on anything?
I don't believe so.
Which issue(s) does this PR fix?
Fixes #331. Or at least it's a start. 😀