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

Add enterprise webpage #16

Merged
merged 1 commit into from
Oct 6, 2024
Merged

Add enterprise webpage #16

merged 1 commit into from
Oct 6, 2024

Conversation

jodastephen
Copy link
Member

@jodastephen jodastephen commented Oct 6, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new section titled "Joda-Collect for Enterprise," detailing Tidelift Subscription benefits.
    • Added a "For Enterprise" menu in the navigation linking to the Tidelift page.
  • Bug Fixes

    • Fixed hyperlink styles for better visibility and accessibility.
  • Documentation

    • Updated project description to clarify compatibility with Java 8.
    • Updated the Tidelift Subscription link to correctly direct users to the Joda-Collect page.
  • Style

    • Enhanced CSS styles for buttons and overall page layout for improved user experience.

Copy link

coderabbitai bot commented Oct 6, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve updates to several files primarily related to project documentation and configuration. The pom.xml file has had its project description modified to indicate compatibility with Java 8. A new section has been added to src/site/markdown/enterprise.md detailing Tidelift's offerings for Joda-Collect users. The src/site/markdown/index.md file has updated a URL for the Tidelift Subscription. The site.css file includes various style adjustments, and src/site/site.xml has a new navigation menu for enterprise-related content.

Changes

File Path Change Summary
pom.xml Updated project description to specify compatibility with Java 8.
src/site/markdown/enterprise.md Added new section "Joda-Collect for Enterprise" detailing Tidelift Subscription offerings.
src/site/markdown/index.md Updated URL in the "For Enterprise" section to point to the correct Tidelift Subscription page.
src/site/resources/css/site.css Fixed hyperlink definitions, adjusted text colours, added styles for buttons and icons, and modified padding.
src/site/site.xml Added new top-level menu "For Enterprise" with a link to "Tidelift" in the navigation structure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Website
    participant Tidelift

    User->>Website: Access Enterprise Page
    Website->>User: Display Enterprise Information
    User->>Tidelift: Request Subscription Info
    Tidelift-->>User: Provide Subscription Details
    User->>Website: Click Learn More
    Website->>Tidelift: Redirect to Subscription Page
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (6)
src/site/resources/css/site.css (1)

54-58: Enterprise page styling looks good, but consider simplifying the selector.

The CSS rule for the enterprise page heading effectively centres the text and adjusts margins. However, the selector h2#Joda-Money_for_Enterprise~div > p:last-child is quite specific. Consider adding a class to the target element for easier maintenance, e.g., .enterprise-summary.

src/site/markdown/enterprise.md (5)

9-10: Consider adding a line break between buttons for better readability.

The buttons are currently on consecutive lines, which might affect their appearance and usability, especially on smaller screens. Consider adding a line break between them for improved layout and user experience.

Apply this change:

 <button class="btn-learnmore" type="button">[LEARN MORE][1]</button>
+
 <button class="btn-requestdemo" type="button">[REQUEST A DEMO][2]</button>
🧰 Tools
🪛 LanguageTool

[uncategorized] ~9-~9: A punctuation mark might be missing here.
Context: ... type="button">[LEARN MORE][1] [REQUEST A DEMO][2] ### Enterprise-rea...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


12-15: Consider hyphenating compound adjectives for clarity.

To improve readability and adhere to grammatical best practices, consider hyphenating compound adjectives that modify nouns. This change will make the text more precise and easier to parse.

Apply these changes:

-### Enterprise-ready open source software - managed for you
+### Enterprise-ready open-source software - managed for you

-The Tidelift Subscription is a managed open source subscription for application dependencies covering millions
-of open source projects across JavaScript, Python, Java, PHP, Ruby, .NET, and more.
+The Tidelift Subscription is a managed open-source subscription for application dependencies covering millions
+of open-source projects across JavaScript, Python, Java, PHP, Ruby, .NET, and more.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...DEMO][2] ### Enterprise-ready open source software - managed for you The Tidelif...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~14-~14: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... The Tidelift Subscription is a managed open source subscription for application dependenci...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~15-~15: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ation dependencies covering millions of open source projects across JavaScript, Python, Jav...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


17-42: Consider these language improvements for clarity and consistency.

The content is informative, but a few minor adjustments could enhance clarity and adhere to British English conventions:

  1. Use "licence" instead of "license" when used as a noun (line 24).
  2. Add a comma before "and" in a compound sentence (line 30).
  3. Consider rephrasing "end result" to be more concise (line 44, outside this range but related).

Apply these changes:

-* **Licensing verification and indemnification**<br />
-Tidelift verifies license information to enable easy policy enforcement and adds intellectual property
+* **Licencing verification and indemnification**<br />
+Tidelift verifies licence information to enable easy policy enforcement and adds intellectual property

-Your managed dependencies are actively maintained and we recruit additional maintainers where required.
+Your managed dependencies are actively maintained, and we recruit additional maintainers where required.

Additionally, consider rephrasing "The end result?" to "The outcome?" or "The result?" in line 44 for conciseness.

🧰 Tools
🪛 LanguageTool

[locale-violation] ~24-~24: license must be spelled with a “c” when used as a noun in British English. Use “licence”.
Context: ...demnification**
Tidelift verifies license information to enable easy policy enfor...

(LICENCE_LICENSE_NOUN_SINGULAR)


[uncategorized] ~30-~30: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ged dependencies are actively maintained and we recruit additional maintainers where...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~33-~33: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nce**
We help you choose the best open source packages from the start—and then guide ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


44-47: Consider this language improvement for conciseness.

The concluding paragraph effectively summarises the benefits, but a small change could make it more concise:

Apply this change:

-The end result? All of the capabilities you expect from commercial-grade software, for the full breadth
+The result? All the capabilities you expect from commercial-grade software, for the full breadth
 of open source you use. That means less time grappling with esoteric open source trivia, and more
 time building your own applications—and your business.

This change removes the potentially wordy phrase "end result" and the unnecessary "of" in "All of the capabilities".

🧰 Tools
🪛 LanguageTool

[style] ~44-~44: ‘end result’ might be wordy. Consider a shorter alternative.
Context: ...nd other deployment targets, too). The end result? All of the capabilities you expect fro...

(EN_WORDINESS_PREMIUM_END_RESULT)


[style] ~44-~44: Consider removing “of” to be more concise
Context: ...loyment targets, too). The end result? All of the capabilities you expect from commercial...

(ALL_OF_THE)


[uncategorized] ~45-~45: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...means less time grappling with esoteric open source trivia, and more time building your own...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


48-49: Consider adding a line break between buttons for better readability.

As with the buttons in the introduction, adding a line break between these buttons would improve their appearance and usability, especially on smaller screens.

Apply this change:

 <button class="btn-learnmore" type="button">[LEARN MORE][1]</button>
+
 <button class="btn-requestdemo" type="button">[REQUEST A DEMO][2]</button>
🧰 Tools
🪛 LanguageTool

[uncategorized] ~48-~48: A punctuation mark might be missing here.
Context: ... type="button">[LEARN MORE][1] [REQUEST A DEMO][2] [1]: https://tidel...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7ecac88 and 41aac82.

📒 Files selected for processing (5)
  • pom.xml (1 hunks)
  • src/site/markdown/enterprise.md (1 hunks)
  • src/site/markdown/index.md (1 hunks)
  • src/site/resources/css/site.css (2 hunks)
  • src/site/site.xml (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/site/markdown/index.md
🧰 Additional context used
🪛 LanguageTool
src/site/markdown/enterprise.md

[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Joda-Collect and thousands of other open source projects to deliver commercial support ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~6-~6: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...mercial support and maintenance for the open source dependencies you use to build your appl...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~9-~9: A punctuation mark might be missing here.
Context: ... type="button">[LEARN MORE][1] [REQUEST A DEMO][2] ### Enterprise-rea...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...DEMO][2] ### Enterprise-ready open source software - managed for you The Tidelif...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~14-~14: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... The Tidelift Subscription is a managed open source subscription for application dependenci...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~15-~15: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ation dependencies covering millions of open source projects across JavaScript, Python, Jav...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[locale-violation] ~24-~24: license must be spelled with a “c” when used as a noun in British English. Use “licence”.
Context: ...demnification**
Tidelift verifies license information to enable easy policy enfor...

(LICENCE_LICENSE_NOUN_SINGULAR)


[uncategorized] ~30-~30: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ged dependencies are actively maintained and we recruit additional maintainers where...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~33-~33: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nce**
We help you choose the best open source packages from the start—and then guide ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[style] ~44-~44: ‘end result’ might be wordy. Consider a shorter alternative.
Context: ...nd other deployment targets, too). The end result? All of the capabilities you expect fro...

(EN_WORDINESS_PREMIUM_END_RESULT)


[style] ~44-~44: Consider removing “of” to be more concise
Context: ...loyment targets, too). The end result? All of the capabilities you expect from commercial...

(ALL_OF_THE)


[uncategorized] ~45-~45: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...means less time grappling with esoteric open source trivia, and more time building your own...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~48-~48: A punctuation mark might be missing here.
Context: ... type="button">[LEARN MORE][1] [REQUEST A DEMO][2] [1]: https://tidel...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

🔇 Additional comments (6)
src/site/resources/css/site.css (4)

19-22: Styling for bold text in main body looks good.

The new CSS rule for .main-body p b appropriately sets the font-weight to bold and applies a dark red colour (#722) for emphasis. This should help important text stand out within paragraphs.


59-67: Button styling looks consistent and well-defined.

The CSS rules for .btn-learnmore and .btn-requestdemo establish a consistent style for these buttons. The width, font size, padding, and border properties are well-defined, ensuring a uniform appearance across the site.


68-75: "Learn More" button styling is consistent with branding.

The CSS rules for .btn-learnmore create a visually appealing button with a white background and orange (#f6914d) border and text. This colour scheme appears to align well with the site's branding. The consistent use of the orange colour for both the border and text is a nice touch.


76-83: "Request Demo" button styling complements the "Learn More" button well.

The CSS rules for .btn-requestdemo create a visually striking button with an orange (#f6914d) background and white text. This complements the "Learn More" button nicely and provides good contrast.

However, to ensure accessibility, it's worth checking the colour contrast ratio between the orange background and white text. You can use tools like the WebAIM Contrast Checker to verify that it meets WCAG 2.0 standards for readability.

src/site/markdown/enterprise.md (1)

51-52: Link references look good.

The link references are correctly formatted and include appropriate UTM parameters for tracking. This section doesn't require any changes.

src/site/site.xml (1)

24-24: LGTM: Top navigation updated correctly

The addition of "For Enterprise" to the top navigation is consistent with the PR objective and aligns with the new menu section. The existing format is maintained, ensuring a seamless integration.

Comment on lines +94 to +96
<menu name="For Enterprise">
<item name="Tidelift" href="enterprise.html"/>
</menu>
Copy link

@coderabbitai coderabbitai bot Oct 6, 2024

Choose a reason for hiding this comment

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

💡 Codebase verification

Action Required: "enterprise.html" Page Missing or Incomplete

  • The "enterprise.html" file appears to be missing or does not contain information about Tidelift.
  • Ensure that src/site/enterprise.html exists and includes detailed information about Tidelift's offerings.
🔗 Analysis chain

LGTM: New "For Enterprise" menu section added correctly

The new menu section is well-structured and aligns with the PR objective. The placement and formatting are appropriate.

Please ensure that the "enterprise.html" page exists and contains the correct information about Tidelift's offerings. You can verify this with the following script:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and content of the enterprise.html file

# Test 1: Check if the file exists
if fd -t f "enterprise.html" src/site; then
  echo "enterprise.html file found."
else
  echo "Error: enterprise.html file not found in the src/site directory."
  exit 1
fi

# Test 2: Check if the file contains information about Tidelift
if rg -q "Tidelift" src/site/enterprise.html; then
  echo "enterprise.html contains information about Tidelift."
else
  echo "Warning: enterprise.html does not mention Tidelift. Please verify the content."
fi

Length of output: 373

Copy link
Member Author

Choose a reason for hiding this comment

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

The file enterprise.html is generated from enterprise.md

Copy link

Choose a reason for hiding this comment

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

@jodastephen Thank you for the clarification. Since enterprise.html is generated from enterprise.md, and enterprise.md is included with the necessary content about Tidelift, everything looks good.

(\・ω・)

@jodastephen jodastephen merged commit d840d78 into main Oct 6, 2024
7 checks passed
@jodastephen jodastephen deleted the enterprise branch October 6, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant