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

The Config section in Settings should have a link to the documentation #1110

Closed
autonome opened this issue Aug 15, 2019 · 2 comments · Fixed by #1113
Closed

The Config section in Settings should have a link to the documentation #1110

autonome opened this issue Aug 15, 2019 · 2 comments · Fixed by #1113

Comments

@autonome
Copy link

Is your feature request related to a problem? Please describe.

The Config section in Settings is JSON in a textarea with no hints or cues about what's possible to put there.

Describe the solution you'd like

As an easy fix to make things better, we can add a link to the documentation of the config options.

Describe alternatives you've considered

More sophisticated configuration UIs are discussed in #879 and ipfs/ipfs-gui#15.

But I think we'd need to link out to the docs either way.

Additional context

My name is Dietrich, and I like chicken burritos.

@autonome autonome changed the title The Config section in Settigns should have a link to the documentation The Config section in Settings should have a link to the documentation Aug 15, 2019
@hacdias hacdias mentioned this issue Aug 15, 2019
16 tasks
@autonome
Copy link
Author

@hacdias wdyt about something like this? Ideally there's an icon or visual indicator that the link opens in a new tab, but at least we'd have something now.

Screen Shot 2019-08-15 at 6 08 04 PM

This seems to be the best page I could find to link to: https://github.com/ipfs/go-ipfs/blob/master/docs/config.md

Do you know of a better reference to link to?

@hacdias
Copy link
Member

hacdias commented Aug 16, 2019

@autonome I just wouldn't agree with that color (maybe a teal would be better).

Yes, that links seems the best one to me. I couldn't find any configuration-related info in docs.ipfs.io...

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 a pull request may close this issue.

2 participants