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

Remove meta site #20775

Merged
merged 35 commits into from
Oct 12, 2022
Merged

Remove meta site #20775

merged 35 commits into from
Oct 12, 2022

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Sep 15, 2022

This PR removes the meta site and migrates older content across from the following pages:

meta
├── legacy
│   ├── adding-images.md            # DONE -> modified media (video) guide
│   ├── archiving.md                # DELETED -> looks obsolete so have omitted
│   ├── code-examples.md            # DONE -> modified Code_examples.md page
│   ├── compat-tables.md            # DONE -> modified Compatibility_tables.md page
│   ├── deployment-timeline.md      # DONE -> modified PR how-to page
│   ├── documentation-priorities.md # DONE -> added new page, we should revisit this!
│   ├── external-content.md         # DELETED -> we can revisit according to review comments
│   └── reuse.md                    # DONE -> modified Attrib_copyright_license.md page
└── writing
    └── style
        └── external-links.md       # DONE -> content already exists in contrib guidelines

Redirects:
I have replaced occurrences of links to mdn-contributor-docs.mozilla.org and manually removed a redirect in files/en-us/_redirects.txt. Please check that this looks okay!

Notes:
Continuing on the work from #20534

TODO:

  • merge code-examples.md with Writing_guidelines/Page_structures/Code_examples
  • merge compat-tables.md with Writing_guidelines/Page_structures/Compatibility_tables
  • merge reuse.md with Attrib_copyright_license
  • BCD specific things are now on the bcd repo -> point to docs there
  • Remove documentation priorities document
  • announce these pages are going
  • remove list of deployment times for repos with no automation yet
  • Redirect https://mdn-contributor-docs.mozilla.org to https://developer.mozilla.org/en-US/docs/MDN

@bsmth bsmth requested review from a team as code owners September 15, 2022 18:00
@bsmth bsmth requested review from hamishwillee and removed request for a team September 15, 2022 18:00
@github-actions github-actions bot added the Content:Other Any docs not covered by another "Content:" label label Sep 15, 2022
@nschonni
Copy link
Contributor

https://github.com/mdn/content/blob/main/netlify.toml can also probably go, if you update the web hooks.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 19, 2022

Preview URLs (8 pages)
Flaws (5)

Note! 5 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/MDN/Community/Pull_requests
Title: Pull request guidelines
Flaw count: 2

  • broken_links:
    • Anchor not lowercase
    • Can't resolve https://developer.mozilla.org/

URL: /en-US/docs/MDN/Writing_guidelines
Title: Writing guidelines
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/MDN/Writing_guidelines/Content_reuse

URL: /en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license
Title: Attribution and copyright licensing
Flaw count: 2

  • broken_links:
    • Link points to the page it's already on
    • Can't resolve https://developer.mozilla.org/en-US/docs/MDN/About#using_mdn_web_docs_content
External URLs (2)

URL: /en-US/docs/MDN/Writing_guidelines/Howto/Images_media
Title: How to add images and media

(this comment was updated 2022-10-12 12:01:29.877080)

@bsmth bsmth requested a review from a team as a code owner September 19, 2022 13:19
@bsmth
Copy link
Member Author

bsmth commented Sep 19, 2022

https://github.com/mdn/content/blob/main/netlify.toml can also probably go, if you update the web hooks.

done in 6b319ff

@bsmth bsmth requested a review from nschonni September 19, 2022 13:22
Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Thanks for this work, @bsmth! 🙌
Pointed out a few nits that could be fixed in the images_media file. I'll resume looking at the other files shortly.

@bsmth
Copy link
Member Author

bsmth commented Sep 20, 2022

This is covered here https://developer.mozilla.org/en-US/docs/MDN/Community/Issues/Issue_triage so a new page is not needed but the page itself needs to be reevaluated.

Actually these are two separate documents

  • Issue Triage (how to work on issues, references docs prio)
  • Documentation Prio (how to tell which docs are high prio)

@bsmth bsmth requested a review from dipikabh September 20, 2022 14:03
@Rumyra
Copy link
Collaborator

Rumyra commented Sep 20, 2022

This is amazing @bsmth thank you!!

Just a couple of things after a quick glance:

  • BCD specific things are now on the bcd repo, the compatibility table page should just be about the macro and frontmatter
  • We have content specific pages for issues and prs in the community section because they differ slightly from other repos in the org (the triage page in meta docs was content specific) - these are pretty much what we are defining now, but the info in the meta page should be captured
  • I think we should do away with document priority actually - it'd be nice if all docs were equal (there's more to unpack here)
  • Make sure redirects are in place (seems so and we're redirecting redirects but the yari tool should cover that)

@Rumyra
Copy link
Collaborator

Rumyra commented Sep 20, 2022

Also I love how all the tests are failing now - seems we've done good work here 👍

@bsmth bsmth self-assigned this Sep 21, 2022
@bsmth bsmth dismissed dipikabh’s stale review October 6, 2022 09:30

Changes resolved

Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Sorry, I missed looking at an addition. Let me know what you think.

Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Thanks, @bsmth for your work on this project! 🙌

@dipikabh
Copy link
Contributor

dipikabh commented Oct 6, 2022

@bsmth
Copy link
Member Author

bsmth commented Oct 6, 2022

Should we redirect https://mdn-contributor-docs.mozilla.org to https://developer.mozilla.org/en-US/docs/MDN?

We can do, indeed. Let me update the request for infra to do this

@bsmth
Copy link
Member Author

bsmth commented Oct 12, 2022

Should we redirect https://mdn-contributor-docs.mozilla.org to https://developer.mozilla.org/en-US/docs/MDN?

A redirect is now active for this. We will merge this PR shortly and proceed with decommissioning the Netlify builds & site.

@bsmth
Copy link
Member Author

bsmth commented Oct 12, 2022

Merging this one now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Other Any docs not covered by another "Content:" label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants