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

#8617 Branding customization docs refactoring #8638

Merged
merged 3 commits into from
May 5, 2022

Conversation

j-n-c
Copy link
Contributor

@j-n-c j-n-c commented Apr 22, 2022

What this PR does / why we need it:

Refactor Branding customization docs:

  • Make it a living document
  • Set expectations on what will change by applying customization
  • Include information about available navbar features

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:



Conflicts:
doc/sphinx-guides/source/installation/config.rst
(new dvPageBlocks image at bottom)
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

Quick question

@@ -2613,3 +2687,6 @@ To override the default list with Docs, Data, Code, and Workflow:
To remove the override and go back to the default list:

``curl -X PUT -d '' http://localhost:8080/api/admin/settings/:FileCategories``

.. |dvPageBlocks| image:: ./img/dvBrandingCustBlocks.png
Copy link
Member

Choose a reason for hiding this comment

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

@j-n-c I'm working on a more complete review, but a quick question for you. How did you create this PNG file? What if we want to edit it in the future? Is it possible to get the source of the image? I'm thinking about an SVG file, for example. Something we can edit. Thanks.

Copy link
Contributor

@poikilotherm poikilotherm May 3, 2022

Choose a reason for hiding this comment

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

nitpick: This appears in the preview, but shouldn't the image be referenced at the place of use? Scrolling all the way down (2000 lines) seems cumbersome.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pdurbin I have used drawio to create the image. You can download the software and run it offline or use the online editor.
Here is the editable file: dv.zip
.

Copy link
Member

Choose a reason for hiding this comment

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

@j-n-c thanks! The "dv.drawio" is only 30 KB so I'll probably just commit it to my branch (I'm planning on making a pull request for you to review).

I was able to import it into https://app.diagrams.net without any trouble. Here's a screenshot:

Screen Shot 2022-05-03 at 10 11 16 AM

@poikilotherm I guess it's personal preference. If you look at the README you'll see a long list of links at the bottom that are used throughout. I see this as similar. Put all that junk at the bottom.

Copy link
Member

Choose a reason for hiding this comment

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

nitpick: This appears in the preview, but shouldn't the image be referenced at the place of use? Scrolling all the way down (2000 lines) seems cumbersome.

@poikilotherm In ErykKul#1 I said "you were right". 😄

People just want to add database settings to the bottom of the config page, as they should. Don't make me think!

Hopefully this wording is considered an improvement!

I also looked into the installation name and how it interacts
with :InstallationName and :SystemEmail.
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

Thanks for kicking off this pull request @j-n-c !I hope you don't mind that I pushed directly to your branch.

Hopefully my changes help with clarity, etc.

@kcondon the interaction between :SystemEmail and :InstallationName wasn't very well specified before so I took a whack at it.

@pdurbin pdurbin removed their assignment May 4, 2022
@kcondon kcondon self-assigned this May 4, 2022
@kcondon kcondon merged commit 700e82c into IQSS:develop May 5, 2022
@pdurbin pdurbin added this to the 5.11 milestone Jun 2, 2022
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.

Documentation: Refactor Branding Your Installation > Custom Header
4 participants