Added Social Media Icons to Introduction Page #311

Kgkunal · 2023-09-16T20:01:24Z

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:

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

…oduction page.

Kgkunal · 2023-09-16T20:06:29Z

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 · 2023-09-17T03:34:18Z

@Kgkunal This is how the page looks with your changes

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 · 2023-09-17T06:37:55Z

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 · 2023-09-17T16:26:16Z

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

anvithks · 2023-09-18T04:57:33Z

@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.

Hugo
Learn theme for Hugo.

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

Kgkunal · 2023-09-19T22:58:21Z

@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 :

anvithks

Thanks @Kgkunal.
Some minor review comments.
Please check.

anvithks · 2023-09-20T02:34:19Z

content/introduction/_index.md

- - [SODA Twitter](https://twitter.com/sodafoundation)  
- - [SODA Mailing List](https://lists.sodafoundation.io)
- - [SODA LinkedIn](https://www.linkedin.com/company/sodafoundation/)
+<ul style="list-style: none; ">


Avoid using inline styles.
You can use classes and add custom styles to this file documentation/static/css/theme-opensds.css
This is the custom theme file that is being used for the website.

Thanks for the feedback! I'll make the changes you suggested to the theme-opensds.css file .

anvithks · 2023-09-20T02:34:35Z

go.mod

@@ -1,3 +1,5 @@
 module github.com/sodafoundation/documentation


No need to check in this file.

anvithks · 2023-09-20T02:34:46Z

go.sum

@@ -0,0 +1,2 @@
+github.com/soda-cdm/documentation v0.0.0-20230525043849-2b985763d78d h1:3xzxcT2yHfhVJWOvnVstPMU9lx3yzZ24RAojwVvHC6I=


No need to check in this file

Seems like this file is still checked in.
Since you had it pushed it to the fork already you will have to delete the file and push the changes again.

anvithks · 2023-09-20T02:37:24Z

content/introduction/_index.md

@@ -6,16 +6,18 @@ disableToc: false
 ---

 ## Introduction
+


Just trying to understand why the newline here and spaces throughout the document have been added.
Was it done by a prettifier plugin?

Yes, the newlines and spaces were added by a prettifier plugin automatically, and I wasn't aware of it. I'll ensure it's disabled to maintain the original formatting.

Kgkunal · 2023-09-22T10:58:29Z

Hi @anvithks ,

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

Removed inline styling for the social media links in the markdown file.
Added classes to the links for external stylesheet styling.
Removed the unnecessary go.mod file.
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!

skdwriting · 2023-09-24T03:03:26Z

content/introduction/_index.md

- - [SODA Mailing List](https://lists.sodafoundation.io)
- - [SODA LinkedIn](https://www.linkedin.com/company/sodafoundation/)
+<ul class="social-list">
+  <li class="social-list-item"><a href="https://sodafoundation.io/the-foundation/join/"><i class="fas fa-globe"></i> SODA Website</a></li>


Please make this link points to - https://www.sodafoundation.io/

@skdwriting I think the link was supposed to point to the Join page. May be the title of the link should be "Join SODA".
After all these links there is a line (line#113) which points to the SODA Website.

skdwriting · 2023-09-24T03:05:27Z

content/introduction/_index.md

+  <li class="social-list-item"><a href="https://lists.sodafoundation.io"><i class="fas fa-envelope"></i> SODA Mailing List</a></li>
+  <li class="social-list-item"><a href="https://www.linkedin.com/company/sodafoundation/"><i class="fab fa-linkedin"></i> SODA LinkedIn</a></li>
+</ul>
+


We can also add a new link:
To know the introduction and how to contribute, you can refer SODA Starter

anvithks

@Kgkunal please remove the go.mod and go.sum file and check in again. Please check @skdwriting comments as well.

anvithks · 2023-09-24T05:52:37Z

content/introduction/_index.md

- - [SODA Mailing List](https://lists.sodafoundation.io)
- - [SODA LinkedIn](https://www.linkedin.com/company/sodafoundation/)
+<ul class="social-list">
+  <li class="social-list-item"><a href="https://sodafoundation.io/the-foundation/join/"><i class="fas fa-globe"></i> SODA Website</a></li>


@skdwriting I think the link was supposed to point to the Join page. May be the title of the link should be "Join SODA".
After all these links there is a line (line#113) which points to the SODA Website.

anvithks · 2023-09-25T04:16:27Z

go.sum

@@ -0,0 +1,2 @@
+github.com/soda-cdm/documentation v0.0.0-20230525043849-2b985763d78d h1:3xzxcT2yHfhVJWOvnVstPMU9lx3yzZ24RAojwVvHC6I=


Seems like this file is still checked in.
Since you had it pushed it to the fork already you will have to delete the file and push the changes again.

Kgkunal · 2023-10-09T18:08:41Z

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.....

Added social media icons (Twitter, Slack, LinkedIn, etc.) to the Intr…

2026de0

…oduction page.

Fixing social media icons

18d433d

anvithks requested changes Sep 20, 2023

View reviewed changes

Kgkunal force-pushed the issue/add-social-icons branch from b63956c to 18d433d Compare September 22, 2023 11:17

Add custom CSS styles for social media links

a87701b

Kgkunal requested a review from anvithks September 22, 2023 11:32

skdwriting reviewed Sep 24, 2023

View reviewed changes

anvithks requested changes Sep 25, 2023

View reviewed changes

Kgkunal added 2 commits October 9, 2023 23:22

Remove go.mod and go.sum files

b9f29b1

Title SODA Website changed to Join Soda

aa72c93

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Social Media Icons to Introduction Page #311

Added Social Media Icons to Introduction Page #311

Kgkunal commented Sep 16, 2023

Kgkunal commented Sep 16, 2023

anvithks commented Sep 17, 2023

Kgkunal commented Sep 17, 2023

Kgkunal commented Sep 17, 2023

anvithks commented Sep 18, 2023

Kgkunal commented Sep 19, 2023

anvithks left a comment

anvithks Sep 20, 2023

Kgkunal Sep 20, 2023

anvithks Sep 20, 2023

anvithks Sep 20, 2023

anvithks Sep 25, 2023

anvithks Sep 20, 2023

Kgkunal Sep 20, 2023

Kgkunal commented Sep 22, 2023

skdwriting Sep 24, 2023

anvithks Sep 24, 2023

skdwriting Sep 24, 2023

anvithks left a comment

anvithks Sep 24, 2023

anvithks Sep 25, 2023

Kgkunal commented Oct 9, 2023

		@@ -1,3 +1,5 @@
		module github.com/sodafoundation/documentation

		@@ -0,0 +1,2 @@
		github.com/soda-cdm/documentation v0.0.0-20230525043849-2b985763d78d h1:3xzxcT2yHfhVJWOvnVstPMU9lx3yzZ24RAojwVvHC6I=

Added Social Media Icons to Introduction Page #311

Are you sure you want to change the base?

Added Social Media Icons to Introduction Page #311

Conversation

Kgkunal commented Sep 16, 2023

Kgkunal commented Sep 16, 2023

anvithks commented Sep 17, 2023

Kgkunal commented Sep 17, 2023

Kgkunal commented Sep 17, 2023

anvithks commented Sep 18, 2023

Kgkunal commented Sep 19, 2023

anvithks left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kgkunal commented Sep 22, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anvithks left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kgkunal commented Oct 9, 2023