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

Support project documentation without CK Editor upgrade #3478

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ciyer
Copy link
Contributor

@ciyer ciyer commented Jan 10, 2025

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

image

Show edit view in a modal dialog

image image

/deploy

@ciyer ciyer force-pushed the ciyer/project-docu-minimal branch from a79784a to a465c67 Compare January 10, 2025 13:17
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 10, 2025 13:17 — with GitHub Actions Inactive
@RenkuBot
Copy link
Contributor

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

@ciyer ciyer force-pushed the ciyer/project-docu-minimal branch from a465c67 to 2d76097 Compare January 10, 2025 16:35
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 10, 2025 16:35 — with GitHub Actions Inactive
@ciyer ciyer force-pushed the ciyer/project-docu-minimal branch from 5d924b5 to 52e620d Compare January 10, 2025 17:43
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 10, 2025 17:43 — with GitHub Actions Inactive
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 13, 2025 10:10 — with GitHub Actions Inactive
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 14, 2025 11:10 — with GitHub Actions Inactive
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 15, 2025 10:20 — with GitHub Actions Inactive
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 16, 2025 13:31 — with GitHub Actions Inactive
@ciyer ciyer force-pushed the ciyer/project-docu-minimal branch from 5dd97f9 to 2aa8034 Compare January 17, 2025 09:46
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 17, 2025 09:49 — with GitHub Actions Inactive
@ciyer ciyer force-pushed the ciyer/project-docu-minimal branch from 2aa8034 to e5afcce Compare January 17, 2025 10:38
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 17, 2025 10:38 — with GitHub Actions Inactive
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 17, 2025 12:27 — with GitHub Actions Inactive
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 17, 2025 12:44 — with GitHub Actions Inactive
@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 17, 2025 12:56 — with GitHub Actions Inactive
Copy link
Member

@leafty leafty left a 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.

@ciyer ciyer temporarily deployed to renku-ci-ui-3478 January 17, 2025 14:46 — with GitHub Actions Inactive
Copy link
Member

@leafty leafty 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 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.

Screenshot 2025-01-20 at 14 54 18 Screenshot 2025-01-20 at 14 56 12

Copy link
Member

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.

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.

4 participants