-
Notifications
You must be signed in to change notification settings - Fork 6
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
Support project documentation without CK Editor upgrade #3478
base: main
Are you sure you want to change the base?
Conversation
a79784a
to
a465c67
Compare
You can access the deployment of this PR at https://renku-ci-ui-3478.dev.renku.ch |
a465c67
to
2d76097
Compare
5d924b5
to
52e620d
Compare
5dd97f9
to
2aa8034
Compare
2aa8034
to
e5afcce
Compare
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.
Looks good, some small comments below.
client/src/features/ProjectPageV2/ProjectPageContent/Documentation/Documentation.tsx
Show resolved
Hide resolved
client/src/features/ProjectPageV2/ProjectPageContent/Documentation/Documentation.tsx
Outdated
Show resolved
Hide resolved
client/src/features/ProjectPageV2/ProjectPageContent/Documentation/Documentation.tsx
Outdated
Show resolved
Hide resolved
client/src/features/ProjectPageV2/ProjectPageContent/Documentation/Documentation.module.scss
Outdated
Show resolved
Hide resolved
client/src/features/ProjectPageV2/ProjectPageContent/Documentation/Documentation.tsx
Outdated
Show resolved
Hide resolved
client/src/features/ProjectPageV2/ProjectPageContent/Documentation/Documentation.tsx
Outdated
Show resolved
Hide resolved
client/src/features/ProjectPageV2/ProjectPageContent/Documentation/Documentation.tsx
Outdated
Show resolved
Hide resolved
client/src/features/ProjectPageV2/ProjectPageContent/Documentation/Documentation.tsx
Outdated
Show resolved
Hide resolved
aa4c2a6
to
c82a37b
Compare
c82a37b
to
a074ae9
Compare
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 looks good to me and can be merged.
Some general comment (does not need fixing now): trying out the feature, it seems to me that I would be much more satisfied using an editor similar to what GitHub uses (raw markdown with preview) than what CK editor offers. As seen from the screenshot, we can render language-specific code block and more (e.g. mermaid charts) while these do not get a good preview or edit support from CK editor.
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.
Do we need the new entries here? I'm not sure I see comments/code with these words.
Separate the project documentation support from the ck-editor upgrade in #3390.
Screenshots
UI changes compared to initial version
Display text if there is no documentation
Show edit view in a modal dialog
/deploy