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

Update Documentation #34

Closed
3 tasks
carlad opened this issue Feb 20, 2018 · 6 comments
Closed
3 tasks

Update Documentation #34

carlad opened this issue Feb 20, 2018 · 6 comments
Assignees

Comments

@carlad
Copy link
Contributor

carlad commented Feb 20, 2018

@carlad carlad changed the title Documentation Update Documentation Feb 20, 2018
@carlad carlad mentioned this issue Feb 20, 2018
3 tasks
@plaindocs
Copy link
Contributor

What I currently have is https://deploy-preview-1554--musing-lamport-7fb66c.netlify.com/user/travisyml/ from work in travis-ci/docs-travis-ci-com#1554 .

As I see it there are main options:

  • Make it so that docs.travis-ci.org/user/yamlref/ redirects straight to the link I have for each key.
  • Add title and description on my side, expanding the current list, and you can just link to /yamlref/# which will take you the relevant section on the page, with a link to more info

Thoughts welcome.

@carlad
Copy link
Contributor Author

carlad commented Feb 21, 2018

@backspace do you have any thoughts on plaindocs' comments above? Is there a preferred way in terms of what works best with travis-web?

@carlad
Copy link
Contributor Author

carlad commented Feb 21, 2018

sorry - just saw your comment on the other issue:
#33 (comment)

Regarding “link to documentation”, it would be ideal if the link were accomplished through anchors, or some consistent way we can generate a link from a key. We could instead maintain a map of key to URL, but that seems unwieldy.

@FranklinYu
Copy link

On WebLint page:

We are also working on a new WebLint tool.

So is there “a new WebLint tool”?

@carlad
Copy link
Contributor Author

carlad commented May 29, 2018

Hi @FranklinYu there is one in the works. It's not quite production-ready, and is designed to work with the new travis-yml parsing library that's in very early pre-alpha release. If you'd like more info about opting in to using this new library and getting access to the new config parsing tool, please drop an email to support@travis-ci.com and they'll be able to help.

@svenfuchs
Copy link
Contributor

i think this can be closed. all three items seem to be implemented.

please reopen if needed.

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

No branches or pull requests

4 participants