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

feat(docs): new design for renku docs #2166

Merged
merged 4 commits into from
Jul 9, 2021
Merged

feat(docs): new design for renku docs #2166

merged 4 commits into from
Jul 9, 2021

Conversation

vfried
Copy link
Contributor

@vfried vfried commented Jun 20, 2021

New design for docs

image

/deploy

@vfried vfried requested a review from a team June 20, 2021 18:54
@vfried vfried temporarily deployed to ci-renku-2166 June 20, 2021 18:54 Inactive
@RenkuBot
Copy link
Collaborator

You can access the deployment of this PR at https://ci-renku-2166.dev.renku.ch

@vfried vfried temporarily deployed to ci-renku-2166 June 20, 2021 18:59 Inactive
@rokroskar
Copy link
Member

This looks really great!! Do you think it would be possible to apply these changes to the renku sphinx theme? That way the other repos that might publish their own documentation pages can use the same theme

@vfried
Copy link
Contributor Author

vfried commented Jun 21, 2021

Yes, that's a good point... i spoke with ralph this morning to apply this to renku python but it would be easier to apply only to one place. At the moment we are not using the renku theme, we are using the read the docs one and this changes apply to the read the docs theme... https://github.com/readthedocs/sphinx_rtd_theme we could fork these theme and apply this design there.

@rokroskar
Copy link
Member

I know we're not using it now, but we used to use it so the repo is already there. It's fine if it's completely overwritten, but having it there would make it easier to maintain.

@vfried
Copy link
Contributor Author

vfried commented Jun 21, 2021

I will see how i can overwrite the theme in the renku repo then.

@rokroskar
Copy link
Member

I think you should be able to copy over the static directory into the theme here and set the RTD theme as the base here

Copy link
Contributor

@ciyer ciyer left a comment

Choose a reason for hiding this comment

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

This looks very nice! 🎉

The suggestions Rok made make sense to me as well. As part of that conversion, I found a couple of files that should probably be removed (see comments), and, as we discussed, I think it would be nice if the css were autogenerated from the scss files (which might require changes to the config and the makefile), but if that is complicated to do, it should be at least documented that the css files should not be edited and how they can be generated.

I will do a full review after the restructuring, but I have already looked at the changes, so I do not expect anything major -- it looks very good!

@vfried vfried requested a review from a team as a code owner June 30, 2021 15:58
@vfried vfried temporarily deployed to ci-renku-2166 June 30, 2021 15:59 Inactive
@vfried
Copy link
Contributor Author

vfried commented Jun 30, 2021

Changes are now in the renku-sphinx repo.

For testing:
image

@vfried vfried temporarily deployed to ci-renku-2166 June 30, 2021 16:05 Inactive
ciyer
ciyer previously approved these changes Jul 1, 2021
Copy link
Contributor

@ciyer ciyer left a comment

Choose a reason for hiding this comment

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

These look great!

@ciyer ciyer force-pushed the ui-design-2021 branch from 27e6035 to 8538c36 Compare July 2, 2021 09:05
@vfried vfried requested a review from a team as a code owner July 2, 2021 09:05
@ciyer ciyer force-pushed the ui-design-2021 branch from 8538c36 to fe72657 Compare July 2, 2021 09:58
@vfried vfried changed the base branch from ui-design-2021 to master July 8, 2021 15:00
@vfried vfried dismissed ciyer’s stale review July 8, 2021 15:00

The base branch was changed.

@vfried vfried temporarily deployed to ci-renku-2166 July 8, 2021 15:01 Inactive
@vfried vfried temporarily deployed to ci-renku-2166 July 8, 2021 15:07 Inactive
@vfried vfried temporarily deployed to ci-renku-2166 July 8, 2021 15:34 Inactive
@vfried vfried force-pushed the ui-design-docs branch 3 times, most recently from afcf1a3 to f5e407e Compare July 9, 2021 08:33
@vfried vfried temporarily deployed to ci-renku-2166 July 9, 2021 08:35 Inactive
@vfried vfried temporarily deployed to ci-renku-2166 July 9, 2021 08:38 Inactive
@olevski olevski deployed to ci-renku-2166 July 9, 2021 10:00 Active
Copy link
Contributor

@ciyer ciyer left a comment

Choose a reason for hiding this comment

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

👍

@vfried vfried merged commit f2f3985 into master Jul 9, 2021
@vfried vfried deleted the ui-design-docs branch July 9, 2021 11:09
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.

5 participants