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

[Task] Update support docs with submodule mkdocs SA 5307 #19

Merged

Conversation

RSAK56
Copy link
Contributor

@RSAK56 RSAK56 commented May 24, 2024

Description

  1. Updated support docs with mkdocs theme common submodule
  2. Shifted vocabulary to vale and removed vocabulary submodule
    Fixes # (issue)
    UI/UX

Type of change

Enhancement

  • Bug fix (non-breaking change which fixes an issue)
  • UI/UX modification
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@RSAK56 RSAK56 added the enhancement New feature or request label May 24, 2024
@RSAK56 RSAK56 self-assigned this May 24, 2024
Copy link

github-actions bot commented May 24, 2024

@karl-johan-grahn Image is available for testing. docker pull ghcr.io/stakater/support-docs:v0.0.15

Copy link
Contributor

@karl-johan-grahn karl-johan-grahn left a comment

Choose a reason for hiding this comment

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

the logos you added are generic, why are they not part of the common theme?

ufateh
ufateh previously approved these changes May 24, 2024
@RSAK56
Copy link
Contributor Author

RSAK56 commented May 24, 2024

the logos you added are generic, why are they not part of the common theme?

They will be updated for each theme separately, when provided by marketing team or designers. But we need to configure that now, rather than later.
So when we get those updated logos, we'll just need to replace the logo's with the updated ones rather than configuring the common theme for all docs again.

@RSAK56 RSAK56 requested a review from karl-johan-grahn May 24, 2024 19:31
@karl-johan-grahn
Copy link
Contributor

The common theme should contain the default logos. For this doc set, the default logos should be used. So they should come from the common theme, and not have to be stored here.

@RSAK56
Copy link
Contributor Author

RSAK56 commented May 27, 2024

The common theme should contain the default logos. For this doc set, the default logos should be used. So they should come from the common theme, and not have to be stored here.

Updated footer logos in the theme common and removed from override

Copy link

@RSAK56 Image is available for testing. docker pull ghcr.io/stakater/stakater/support-docs:SNAPSHOT-PR-19-e398c979

Copy link

@RSAK56 Image is available for testing. docker pull ghcr.io/stakater/stakater/support-docs:SNAPSHOT-PR-19-72f34d21

@karl-johan-grahn karl-johan-grahn merged commit 4e7c453 into main May 27, 2024
5 checks passed
@karl-johan-grahn karl-johan-grahn deleted the task/update-support-docs-with-submodule-mkdocs-sa-5307 branch May 27, 2024 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants