Skip to content

Add license notice space#611

Merged
dgarcia360 merged 1 commit intoscylladb:masterfrom
dgarcia360:add-notice-section
Nov 15, 2022
Merged

Add license notice space#611
dgarcia360 merged 1 commit intoscylladb:masterfrom
dgarcia360:add-notice-section

Conversation

@dgarcia360
Copy link
Copy Markdown
Collaborator

@dgarcia360 dgarcia360 commented Nov 8, 2022 •
edited
Loading

Related issue scylladb/java-driver#165

Add a new section for LICENSE information after content.

How to test this PR

  1. Edit sphinx_scylladb_theme/notice.html and add the following content:
<div class="notice">
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut tincidunt sapien vitae elementum cursus.
Maecenas dignissim libero sapien, pretium posuere sem imperdiet eget.
</div>
  1. Build the docs with make preview. You should see the notice after the prev / next navigation buttons on every page.

Preview:

image

Once we merge this pull request, we can release a new patch to release a new version of the theme.

Then, we will override the notice.html template in the repos java-driver and python-driver.

@dgarcia360 dgarcia360 added the enhancement New feature or request label Nov 8, 2022
@dgarcia360 dgarcia360 changed the title docs: add license notice space Add license notice space Nov 8, 2022
@dgarcia360 dgarcia360 marked this pull request as ready for review November 8, 2022 14:41
@dgarcia360 dgarcia360 requested a review from tzach November 8, 2022 14:44
@annastuchlik
Copy link
Copy Markdown
Collaborator

annastuchlik commented Nov 14, 2022

The spacing didn't look quite right:
image

So I added the <br> tag to the notice.html file, and now it looks great:
image

annastuchlik
annastuchlik approved these changes Nov 14, 2022
View reviewed changes
Copy link
Copy Markdown
Collaborator

@annastuchlik annastuchlik left a comment

Choose a reason for hiding this comment

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

LGTM

@dgarcia360 dgarcia360 merged commit 4718b4b into scylladb:master Nov 15, 2022
@dgarcia360 dgarcia360 mentioned this pull request Nov 29, 2022
Merged
@dgarcia360 dgarcia360 mentioned this pull request Jan 20, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@annastuchlik annastuchlik annastuchlik approved these changes

@tzach tzach Awaiting requested review from tzach

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dgarcia360 @annastuchlik