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

Set up feedback widget #449

Merged
merged 27 commits into from
May 18, 2023
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
38c489b
Merge branch 'main' of https://github.com/TBD54566975/developer.tbd.w…
dayhaysoos May 5, 2023
6e74d52
Set up feedback widget
dayhaysoos May 8, 2023
08651c9
added expandability
dayhaysoos May 9, 2023
f20278f
Removed need for expand animation
dayhaysoos May 10, 2023
cf5d308
Merge branch 'undo-expand' into issue-448/create-feedback-widget
dayhaysoos May 10, 2023
492ecd7
remove unneeded code
dayhaysoos May 10, 2023
3cb9c3b
Merge branch 'phase-4' of https://github.com/TBD54566975/developer.tb…
dayhaysoos May 11, 2023
773ffcf
Merge branch 'phase-4' of https://github.com/TBD54566975/developer.tb…
dayhaysoos May 11, 2023
70ff409
add community page with feedback widget
dayhaysoos May 11, 2023
065a606
update feedback widget with content and some styling changes
dayhaysoos May 12, 2023
c6149fa
Set up feedback widget
dayhaysoos May 8, 2023
9ef809d
added expandability
dayhaysoos May 9, 2023
4e7f3a8
Removed need for expand animation
dayhaysoos May 10, 2023
d0b3b10
remove unneeded code
dayhaysoos May 10, 2023
a70e6a6
add community page with feedback widget
dayhaysoos May 11, 2023
bc5b09c
update feedback widget with content and some styling changes
dayhaysoos May 12, 2023
f3c6cac
Merge branch 'issue-448/create-feedback-widget' of https://github.com…
dayhaysoos May 16, 2023
46248b1
Update URLs for phase-4
dayhaysoos May 16, 2023
cabe4d3
update copy
dayhaysoos May 16, 2023
acffe2f
fix link
dayhaysoos May 16, 2023
91f5d7f
Update contributing.mdx
EbonyLouis May 16, 2023
6be32f8
Update contributing.mdx
EbonyLouis May 16, 2023
45f03eb
test
EbonyLouis May 16, 2023
5020ea3
Update contributing.mdx
EbonyLouis May 16, 2023
3795620
Update contributing.mdx
EbonyLouis May 16, 2023
f8efd89
Merge branch 'issue-448/create-feedback-widget' of https://github.com…
dayhaysoos May 17, 2023
a07ff70
updated with fixed height
dayhaysoos May 17, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/components/Card.jsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
/* eslint-disable react/prop-types */
import React from 'react';

function Card({ children }) {
function Card({ children, className }) {
return (
<div className="flex flex-col bg-transparent border-[#282828] border-2 shadow overflow-hidden sm:rounded-lg lg:p-10 sm:p-5 lg:mb-6">
<div
className={`flex flex-col bg-transparent border-[#282828] border-2 shadow overflow-hidden sm:rounded-lg lg:p-10 sm:p-5 ${className}`}
>
{children}
</div>
);
Expand Down
35 changes: 35 additions & 0 deletions src/components/FeedbackWidget.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import React from 'react';
import Card from './Card';
import Link from '@docusaurus/Link';

function FeedbackWidget() {
return (
<div className="flex justify-end lg:mt-8">
<Card className={'w-full'}>
<h3 className="text-3xl">Was this page helpful?</h3>
<p>
Connect with us on{' '}
<a href="https://discord.com/invite/tbd">Discord</a>
</p>
<p>
Submit feedback:{' '}
<a href="https://github.com/TBD54566975/developer.tbd.website/issues/new/choose">
Open a GitHub issue
</a>
</p>
<p>
Edit this page:{' '}
<a href="https://github.com/TBD54566975/developer.tbd.website/tree/main/docs">
GitHub Repo
</a>
</p>
<p>
Contribute:{' '}
<Link to="/open-source/contributing">Contributing Guide</Link>
</p>
</Card>
</div>
);
}

export default FeedbackWidget;
26 changes: 22 additions & 4 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -165,10 +165,6 @@ main.col.col--7 article.margin-bottom--xl {
padding-bottom: 5rem;
}

article {
padding: 2rem;
}

article p img {
border: 2px solid var(--color-blue);
}
Expand Down Expand Up @@ -501,3 +497,25 @@ footer a:hover {
border: none !important;
}
}

.expandable-content {
max-height: 0;
overflow: hidden;
transition: max-height 0.3s ease-in-out;
}

.expand-btn {
transform: scaleY(-1);
padding: 0;
transition: 0.3s ease-in-out;
margin: auto;
padding: 1rem;
}

.expand-btn.expandable-content-expanded {
transform: scaleY(1);
}

.expandable-content-expanded {
max-height: 300px; /* Adjust this value based on the actual content height */
}
62 changes: 62 additions & 0 deletions src/pages/open-source/contributing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import CommunitySection from '../../components/Community'

# Welcome to Our Contributor Community!
We're thrilled that you're interested in becoming a part of our thriving community. We believe in fostering an environment where everyone feels welcome and is able to contribute. To ensure the well-being of our community, we adhere to a [Code of Conduct](/code-of-conduct). Please take a moment to read it thoroughly before making any contributions.

Before you begin working on an issue, please familiarize yourself with the project's contribution guidelines in their contributing.md. This will provide you with an understanding of the project's process.

## How Can You Contribute?
There are numerous ways to contribute to TBD. Here are some suggestions to get started. If you have any questions or need help, feel free to reach out to us on [Discord](https://discord.gg/tbd).

* **Stars on GitHub:** If you resonate with our mission and believe in a decentralized web, consider starring our projects on GitHub! 🌟
* **Ask Questions:** Your questions not only help us improve but also benefit the community. If you have a question, don't hesitate to ask it in [Discord](https://discord.gg/tbd).
* **Contribute to the Codebase:** We welcome any and all contributors to help us push the web forward by building a decentralized ecosystem.
* **Participate in Community Events:** We host a variety of community events on our Discord stage every month, ranging from Show & Tells to brainstorming sessions. Got an event idea or wish to host one? Post it in our [#community-events forum](https://discord.com/channels/937858703112155166/1101192919706255430). The DWN project also host office hours every Tuesday. All events will be posted in our events calendar in Discord.
* **Write a Blog Post:** Are you passionate about writing? Share your expertise and insights with our community! We welcome your contributions to our blog section on the [TBD Developer website](https://developer.tbd.website/blog). Propose blog topics in our [#general channel](https://discord.com/channels/937858703112155166/937858703820980296) on Discord. We can't wait to read and share them with the community!
* **Propose a New Project:** We're always looking for new projects. At TBD we call them incubation projects, you can find out more [here](https://developer.tbd.website/open-source/incubation). We can't wait to see what you're working on!
* **Improve Documentation:** Good documentation is key to the success of any project. You can help improve the quality of our [existing docs](https://github.com/TBD54566975/developer.tbd.website/tree/main/docs) or add new pages.
* **Showcase Your Work:** Working on a project or written a blog post recently? Share it with the community in our [#share-what-you-do channel](https://discord.com/channels/937858703112155166/1098207585661878402).
* **Give Feedback:** We're always looking for ways to improve. If you have feedback on our website or docs, feel free to use our [feedback template](https://github.com/TBD54566975/developer.tbd.website/issues/new/choose).
* **Give Shoutouts:** Is there a project you love or a community/TBD member who's been especially helpful? Feel free to give them a shoutout in our [#general channel](https://discord.com/channels/937858703112155166/937858703820980296).
* **Spread the Word:** Help us reach more people by sharing [TBD's projects](https://github.com/TBD54566975), [website](https://developer.tbd.website/docs/), and/or [Twitter](https://twitter.com/TBDDev).



## Good First Issues
We understand that contributing to open source for the first time can be daunting. That's why we've highlighted some repositories with good first issues. Be sure to check the repo's contribution guidelines and don't hesitate to ask any questions on [Discord](https://discord.gg/tbd) or on the issue ticket itself. We're looking forward to celebrating your first commit with you! 🎉
* [Developer Website](https://github.com/TBD54566975/developer.tbd.website/issues?q=is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee)
* [Web5-JS](https://github.com/TBD54566975/web5-js/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee+label%3A%22good+first+issue%22)
* [SSI-Service](https://github.com/TBD54566975/ssi-service/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee+label%3A%22good+first+issue%22)
* [SSI-SDK](https://github.com/TBD54566975/ssi-sdk/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee+label%3A%22good+first+issue%22)
* [SSI-Playground](https://github.com/TBD54566975/ssi-playground/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee+label%3A%22good+first+issue%22)
* [SSI-admin-ui](https://github.com/TBD54566975/ssi-admin-ui/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee+label%3A%22good+first+issue%22)
* [DWN-Server](https://github.com/TBD54566975/dwn-server/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee+label%3A%22good+first+issue%22)
* [DWN-SDK-JS](https://github.com/TBD54566975/dwn-sdk-js/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee+label%3A%22good+first+issue%22)


## New Open Issues
We've highlighted some repositories with new open issues to help you get started. We currently have 51 repositories. So if you don't see a project here that you're interested in. Check out our [other repos here](https://github.com/orgs/TBD54566975/repositories).

* [Developer Website](https://github.com/TBD54566975/developer.tbd.website/issues?q=is%3Aopen+is%3Aissue)
* [Web5-JS](https://github.com/TBD54566975/web5-js/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
* [SSI-Service](https://github.com/TBD54566975/ssi-service/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
* [SSI-SDK](https://github.com/TBD54566975/ssi-sdk/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
* [SSI-Playground](https://github.com/TBD54566975/ssi-playground/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
* [SSI-admin-ui](https://github.com/TBD54566975/ssi-admin-ui/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
* [DWN-Server](https://github.com/TBD54566975/dwn-server/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
* [DWN-SDK-JS](https://github.com/TBD54566975/dwn-sdk-js/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)

## Upcoming Community Events

[![](https://hackmd.io/_uploads/HyRH4X-Sn.png)](https://discord.com/events/937858703112155166/1101242445536182302)

### Community Led Events:

[![](https://hackmd.io/_uploads/ByF_NXWHn.png)](https://discord.com/events/937858703112155166/1108018586729070673)


## License

When contributing to projects under TBD you agree to license your contributions under [Apache License 2.0](https://github.com/TBD54566975/tbd-project-template/blob/main/LICENSE).

<Community />
11 changes: 11 additions & 0 deletions src/theme/DocItem/Footer/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import React from 'react';
import FeedbackWidget from '../../../components/FeedbackWidget';
import EditThisPage from '@theme/EditThisPage';

export default function FooterWrapper(props) {
return (
<>
<FeedbackWidget EditThisPage={EditThisPage} />
</>
);
}
18 changes: 1 addition & 17 deletions src/theme/Layout/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,12 @@ import React, { useEffect } from 'react';
import Layout from '@theme-original/Layout';
import GlitchWrapper from '@site/src/components/GlitchWrapper';
import MDXContent from '@theme/MDXContent';
import { useLocation } from '@docusaurus/router';

export function ScrollToTop() {
const { pathname } = useLocation();

useEffect(() => {
document.body.scrollTo(0, 0);
}, [pathname]);

return null;
}

export default function LayoutWrapper(props) {
const { pathname } = useLocation();

return (
<GlitchWrapper>
<MDXContent>
<Layout {...props}>
<ScrollToTop />
{props.children}
</Layout>
<Layout {...props}>{props.children}</Layout>
</MDXContent>
</GlitchWrapper>
);
Expand Down
8 changes: 7 additions & 1 deletion src/theme/MDXComponents.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import Divider from '@site/src/components/Divider';
import PillarList from '@site/src/components/PillarList';
import SwitchIllustration from '@site/src/components/SwitchIllustration';
import TwoColumnContainer from '@site/src/components/TwoColumnContainer';
import Community from '@site/src/components/Community';

export default {
...MDXComponents,
Expand All @@ -20,6 +21,11 @@ export default {
PillarList: PillarList,
SwitchIllustration: SwitchIllustration,
TwoColumnContainer: TwoColumnContainer,
Community: Community,
p: (props) => <p {...props} className="my-6 copy" />,
ul: (props) => <ul {...props} className="list-disc pl-6 copy" />,
ul: (props) => <ul {...props} className="list-disc pl-6 copy my-8" />,
li: (props) => <li {...props} className="my-4" />,
strong: (props) => (
<strong {...props} className="font-bold text-primary-yellow" />
),
};