sodafoundation / documentation

Documentation for SODA Foundation and SODA Core projects. Covers code for doc site generation.
https://docs.sodafoundation.io/
MIT License
46 stars 220 forks source link

Added Social Media Icons to Introduction Page #311

Open Kgkunal opened 1 year ago

Kgkunal commented 1 year ago

What type of PR is this?

/kind enhancement

What this PR does / why we need it: This PR enhances the Introduction page of the SODA Foundation's documentation by adding social media icons (Twitter, Slack, LinkedIn, etc.) alongside the existing textual links. This improvement aims to provide a more visually appealing and user-friendly experience, allowing users to easily access the foundation's social media channels.

Which issue(s) this PR fixes: Fixes #83

Test Report Added?:

/kind TESTED

Test Report: Tested the changes locally by rendering the markdown file with the added icons and verified that the icons display correctly and link to the respective social media channels.

Test Preview:

image_2023-09-17_012803383

Special notes for your reviewer: No special notes at this time.

Kgkunal commented 1 year ago

Hi @rajat-soda and @anvithks,

I'd like to kindly request your review of this PR. It enhances the Introduction page of our documentation by adding social media icons for improved user experience. Your feedback and insights would be greatly appreciated.

Thank you in advance for taking the time to review.....

anvithks commented 1 year ago

@Kgkunal This is how the page looks with your changes image

You can check out the same in the deploy preview here

The alignment seems to be off. The logo size is very small as well. Could you try to fix these ?

Kgkunal commented 1 year ago

Hi @anvithks,

Thank you for your feedback and for pointing out the alignment and logo size issues. I apologize for any inconvenience this may have caused.

I've taken your feedback into account, and I understand that the differences you observed between the VS Code preview and the deploy preview are due to the way the VS Code extension renders Markdown files versus how they appear in the deployed environment. VS Code may have some variations in rendering, and the deploy preview provides a more accurate representation of how the changes will appear on the actual website.

I appreciate your understanding and patience as we work to align the changes with the desired standards. I'll prioritize addressing the alignment and logo size issues to ensure they meet the requirements for the deployed site.

Once the adjustments are made, I will update the PR for your review.

Kgkunal commented 1 year ago

@anvithks please guide me how can I check deployment preview of the page in my system. In my VSCode setup.. preview is different.

anvithks commented 1 year ago

@anvithks please guide me how can I check deployment preview of the page in my system. In my VSCode setup.. preview is different.

Hey @Kgkunal to setup the documentation on your local environment you can run the ./install_local.sh script and follow the on screen instructions.

This script works on Ubuntu but you can setup the documentation on other OS by installing the pre-requistes.

All of this is taken care by the install_local.sh script

Kgkunal commented 12 months ago

@anvithks hello , I've resolved the alignment and icon size issues, and I've tested the changes locally. Everything looks good on my end, and the social media icons are rendering correctly. Please review and merge the PR at your earliest convenience.

Thank you.....

Preview : image_2023-09-20_043113700

Kgkunal commented 12 months ago

Hi @anvithks ,

I've made the requested changes in response to your feedback. Here's a summary of the updates:

  1. Removed inline styling for the social media links in the markdown file.
  2. Added classes to the links for external stylesheet styling.
  3. Removed the unnecessary go.mod file.
  4. Addressed the issue with newline characters and spaces throughout the document, which were not intentional.

I've tested these changes locally, and they appear to work as expected. Please review the updates and let me know if there are any additional changes or improvements needed.

Thank you for your guidance and feedback!

Kgkunal commented 11 months ago

Hello @skdwriting and @anvithks ,

I hope you're doing well. I wanted to address the request to remove the go.mod and go.sum files in the pull request.

I attempted to remove these files as requested, and it resulted in all the checks failing. if there's a different approach you'd like me to take, please let me know.....