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

#1933 Embed Contributing.md & First_time.md #2021

Closed
wants to merge 2 commits into from

Conversation

prachi00
Copy link
Member

@prachi00 prachi00 commented Jan 22, 2022

Thank you for your contribution to the KodaDot NFT gallery.
👇 _ Do a quick check before the merge.

PR type

  • Bugfix
  • Feature
  • Refactoring

What's new?

  • PR closes Embed Contributing.md & First_time.md to kodadot web #1933
  • [ ]
    Used nuxt content for doing this
    Had to do css changes as well for this because tags like p, heading tags and table got replaced with other classes from libraries and code and messed with the padding, fonts, margins, borders.

Route is available at /contribute and /firsttime

Needed clarity in whether to delete the md files or keep them in root?

Before submitting Pull Request, please make sure:

  • My contribution builds clean without any errors or warnings
  • I've merged recent default branch -- main and I've no conflicts
  • I've tried respect high code quality standards
  • I've didn't break any original functionality
  • I've posted screenshot of demonstrated change in this PR

Optional

  • I've tested it at </rmrk/collection/26902bc2f7c20c546a-1FVG7>
  • I've tested PR on mobile and everything seems works
  • I found edge cases

Had issue bounty label ?

  • Fill up your KSM address:
    Payout

Community participation

Screenshot

  • My fix has changed something on UI, a screenshot is best to understand changes for others.

Screenshot 2022-01-22 at 6 24 06 PM

Screenshot 2022-01-22 at 6 24 19 PM

@netlify
Copy link

netlify bot commented Jan 22, 2022

✔️ Deploy Preview for koda-nuxt ready!

🔨 Explore the source changes: e6684d1

🔍 Inspect the deploy log: https://app.netlify.com/sites/koda-nuxt/deploys/61ebfeb472a5440007191dd4

😎 Browse the preview: https://deploy-preview-2021--koda-nuxt.netlify.app

@yangwao
Copy link
Member

yangwao commented Jan 22, 2022

I guess for a single point of truth (file)

We do not want to copy stuff over.
The thing would be at build time fetch the content of

To have the most up to date stuff, not maintaining another copy of the file.

@prachi00
Copy link
Member Author

To have the most up to date stuff, not maintaining another copy of the file.

oh okay, I'll check if we can do it this way

@prachi00
Copy link
Member Author

prachi00 commented Jan 22, 2022

@yangwao so the way this works is that nuxtcontent fetches from the content directory, so it wont be able to take the content from

https://github.com/kodadot/nft-gallery/blob/main/CONTRIBUTING.md
https://github.com/kodadot/nft-gallery/blob/main/FIRST_TIME.md

I think we can instead do is shift these files into the content directory only and then access it on github through

https://github.com/kodadot/nft-gallery/blob/main/content/CONTRIBUTING.md
https://github.com/kodadot/nft-gallery/blob/main/content/FIRST_TIME.md

Let me know what you think.

CC @roiLeo @vikiival

Ref: https://nuxtjs.org/docs/directory-structure/content/
https://content.nuxtjs.org/writing

@yangwao
Copy link
Member

yangwao commented Jan 22, 2022

And why isn't possible embed existing CONTRIBUTING.md without copying it into /content directory?

I mean FIRST Time wouldn't be issue but contributing.md is required by gh to be in top level directory tho.

@prachi00
Copy link
Member Author

And why isn't possible embed existing CONTRIBUTING.md without copying it into /content directory?

I mean FIRST Time wouldn't be issue but contributing.md is required by gh to be in top level directory tho.

@yangwao I couldn't find anything like this for nuxt/content

@prachi00
Copy link
Member Author

@yangwao so what are we doing about this? maybe we can go for just first_time.md right now in the contents folder?

@yangwao
Copy link
Member

yangwao commented Jan 30, 2022

I'm thinking we could semantically split some portion from contributing and have it in content if so.

At some point we are having https://docs.kodadot.xyz
Where we could later highlight some portion for whatever reason having it at one single place.

I think I could prepared some light weight timeless version which could be embedded.

Let's keep this PR open and will get back to it later

@vikiival
Copy link
Member

22.01.2022 vs 16.03.2022

I recommend closing this pull request.

@vikiival vikiival closed this Mar 16, 2022
@yangwao yangwao mentioned this pull request Mar 24, 2022
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Embed Contributing.md & First_time.md to kodadot web
3 participants