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

Add link to discourse to help page #730

Merged
merged 2 commits into from
Jan 27, 2020
Merged

Add link to discourse to help page #730

merged 2 commits into from
Jan 27, 2020

Conversation

ciyer
Copy link
Contributor

@ciyer ciyer commented Jan 23, 2020

@ciyer ciyer requested a review from a team as a code owner January 23, 2020 15:02
@ciyer ciyer changed the title Add link to discourse to help page WIP: Add link to discourse to help page Jan 23, 2020
vfried
vfried previously approved these changes Jan 23, 2020
Copy link
Contributor

@vfried vfried left a comment

Choose a reason for hiding this comment

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

All looks good, I just have a small gramatical question... you can dismiss it

<h2>Discourse</h2>
<p>
We maintain a forum on <ExternalDocsLink url="https://renku.discourse.group" title="Discourse" /> for
discussion about Renku. This is a good place to ask questions and find answers.
Copy link
Contributor

Choose a reason for hiding this comment

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

*discussions? (I'm not sure this is correct or not, just asking)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Both discussion and discussions can be used here grammatically because discussion is both a countable and an uncountable noun: https://en.wiktionary.org/wiki/Appendix:Glossary#uncountable

There is a subtle difference in meaning, but not a fundamental one.

@rokroskar
Copy link
Member

How easy would it be to somehow template these pages or otherwise disconnect them from the code? I'm thinking that non-sdsc deployments might want to put different information here.

@ciyer
Copy link
Contributor Author

ciyer commented Jan 24, 2020

It would be simple to let deployments specify the content of the help page in Markdown and render that instead of our default page.

That works for static content like this, but we are also thinking about a plug-in mechanism to make it possible to extend Renkulab and would allow introduction of dynamic content, and maybe it would be better to structure help as a plug-in.

@ciyer ciyer changed the title WIP: Add link to discourse to help page Add link to discourse to help page Jan 24, 2020
@ciyer ciyer requested a review from vfried January 24, 2020 10:34
@lorenzo-cavazzi
Copy link
Member

I like the new content of "Getting Help", it definitely looks better than before!

A minor layout consideration: when the page becomes larger, the content is not aligned anymore on the left and, depending on the browser width, there may be a big gap. Does it make sense to keep it aligned on the left as it's the case with other "tabbed" pages? (e.g. a project's page)

Screenshot_20200127_085752

Screenshot_20200127_085909

@rokroskar
Copy link
Member

That works for static content like this, but we are also thinking about a plug-in mechanism to make it possible to extend Renkulab and would allow introduction of dynamic content, and maybe it would be better to structure help as a plug-in.

Seems like markdown support would get us most of the way there - why would you need dynamic content on the help pages?

@ciyer
Copy link
Contributor Author

ciyer commented Jan 27, 2020

Dynamic content on the help page is probably not necessary, but a plug-in that would display on the Project page would need to be dynamic, and I think we should have just one plug-in mechanism, not different ones depending on whether content is static or dynamic.

@ciyer
Copy link
Contributor Author

ciyer commented Jan 27, 2020

@lorenzo-cavazzi I switched to a Flexbox-based layout. Try this one out.

Copy link
Member

@lorenzo-cavazzi lorenzo-cavazzi left a comment

Choose a reason for hiding this comment

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

Nice!

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.

Add UI Link to Discourse
5 participants