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 NuxtJS documentation (2.15.8) #1832

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thewheat
Copy link
Contributor

@thewheat thewheat commented Oct 8, 2022

Fixes: #1727

If you’re adding a new scraper, please ensure that you have:

  • Tested the scraper on a local copy of DevDocs
  • Ensured that the docs are styled similarly to other docs on DevDocs
  • Added these files to the public/icons/your_scraper_name/ directory:
    • 16.png: a 16×16 pixel icon for the doc
    • 16@2x.png: a 32×32 pixel icon for the doc
    • SOURCE: A text file containing the URL to the page the image can be found on or the URL of the original image itself

Preview

image

@thewheat thewheat requested a review from a team as a code owner October 8, 2022 03:26
@thewheat thewheat mentioned this pull request Oct 8, 2022
Copy link
Contributor

@simon04 simon04 left a comment

Choose a reason for hiding this comment

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

Hi, thank you for this work. Great! Please see my comment on the license, it might be incompatible :/

'NuxtJS',
'2016-present Nuxt Team',
'MIT',
'https://raw.githubusercontent.com/nuxt/nuxt.js/dev/LICENSE'
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
'https://raw.githubusercontent.com/nuxt/nuxt.js/dev/LICENSE'
'https://raw.githubusercontent.com/nuxt/nuxtjs.org/main/LICENSE.md'

Here, we display the license of the docs not the source code.

This one uses https://creativecommons.org/licenses/by-nd/4.0/ "Creative Commons Attribution-NoDerivatives 4.0" – is devdocs.io a derivative? Rather yes? https://creativecommons.org/faq/#what-is-an-adaptation

Here's how we dealt with it in the past #1752 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will try reach out to them to get some clarification. But yeah seems this would be a blocker

Copy link

Choose a reason for hiding this comment

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

I have made some updates to the mc-stan issue regarding the no derivatives clause of the CC license.

class Nuxtjs
class ContainerFilter < Filter
def call
at_css '.docus-content'
Copy link
Contributor

Choose a reason for hiding this comment

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

Simply use options[:container] = '.docus-content' in lib/docs/scrapers/nuxtjs.rb

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe I tried that but it didn't end up following links and thus didn't do a full scrape. But I guess will have to tackle the license issue first 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Nuxt JS
3 participants