#133 Fixed Broken Links
Merged by jflory7. Opened by nasirhm.
nasirhm/fedora-diversity master  into  master

Download 133.patch

I've fixed Broken link, Updated some pages according to latest fedora stuff i.e : Objectives. Fedora Editions.

Docs that i think needs to written :

  • Event Organization Ideas & Guidelines for Fedora D&I
  • Event Report ideas
  • Event Wiki Template
  • Fedora D&I Team Members Page.

Thank You, If you think there are things that needs to be updated, Feel free to update it. :D

According to this Issue#131 we need to improve the on boarding process too.

Hey @nasirhm, I missed this PR! It was buried in notifications.

Thanks for taking initiative on fixing up the links. I have a few comments I will add before this is ready to merge. :) Thanks for working on this.

Metadata Update from @jflory7:
- Request assigned

Metadata Update from @jflory7:
- Pull-request tagged with: bug, needs changes, type - docs

Could you please also fix link:Diversity#Team_Members[Diversity and Inclusion Team member] on this line?

https://docs.fedoraproject.org/en-US/council/diversity-advisor/[Diversity Adviser] should be an xref so it links to the Fedora Council doc page. If the URL schema ever changes, using an xref will make sure the link is always up-to-date. Note that cross-project xref's will not work locally, but they will work when pushed live onto the Fedora Docs site. If you need xref help, come find the Docs team in #fedora-docs :)

This should also be a xref to the Council docs page.

Same xref as above here.

Today I learned this is a wiki page: https://fedoraproject.org/wiki/How_to_organize_a_Fedora_event

I'm not sure how useful this link is right now… we can leave it in for now but maybe we want to remove/replace it. Please link it to the wiki page for now, thanks!

Oops, the xref path is wrong. It should be:

xref:team.adoc[Diversity and Inclusion Team]

This one should work locally since it is a page in the same docs site.

Another cross-site xref here too :)

Another cross-site xref here too :)

Another cross-site xref here too :)

Hmm… our mailing list is a good idea to make a link in our attributes.adoc file, so we can define it once and re-use the same link across the site. Like we do with {FWIKI}:

https://pagure.io/fedora-diversity/blob/0cf16140547626be653428323ade8e456877a127/f/modules/ROOT/pages/_partials/attributes.adoc

This is a little more advanced and out of scope of the PR though. If you have extra time and want to do this, that is awesome! But if not, it's okay too. We can get it in another PR.

One more general comment: please place each sentence on its own line. This is an AsciiDoc convention, but it also makes git diffs waaay easier to read. :) This is the usual standard we follow in other Fedora Docs sites, so best to be consistent here too:

https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line

9 new commits added

  • fix: link to d&i mailinglist
  • fix: fixed the link to D&I team
  • fix: used xref for cross site reference to code-of-conduct
  • using {MAILINGLIST} attribute instead of link
  • add: MAILINGLIST attribute to refer to Diversity Mailing list for re-usability
  • fix: cross-site links with xref
  • used attribution {FWIKI} instead of directly referencing
  • fix: xref to D&I team
  • fix links by using xref for diversity-advior

One more general comment: please place each sentence on its own line. This is an AsciiDoc convention, but it also makes git diffs waaay easier to read. :) This is the usual standard we follow in other Fedora Docs sites, so best to be consistent here too:
https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line

Would try my best to use it as much as i can.

I've added the Mailing list attribute as {MAILINGLIST} that points towards the mailing list's archive.

Made the xrefs, best reference i found was engineering team docs for cross-site xrefs.

Thanks for reviewing. Do let me know if there's anything you would like to see updated. :)

Just an idea… we could probably make a {MAJOROSVER} like the quick-docs project does:

https://pagure.io/fedora-docs/quick-docs/blob/master/f/modules/ROOT/pages/_partials/attributes.adoc

We can open that in a new PR. But it would make this easier to maintain and always point to the Marketing Team's latest work.

Metadata Update from @jflory7:
- Pull-request untagged with: needs changes

3 new commits added

  • One sentence on one line for resource-pack
  • Fix: Addition of MAJOROSVER insures to reuse the latest release version of Fedora
  • Add: MAJOROSVER attribute to point at current major release version

@jflory7 Here ^ are the Changes i made:

  • Addition of {MAJOROSVER} to make it easier to maintain and always point to the marketing team's latest work and used it where i mentioned the release version manually i.e: 32

  • Fixed one sentence per line, I've gone through the docs and feel that it's been fixed.

I love it :smile:

Awesome, thanks @nasirhm! :raised_hands: Merging.

Pull-Request has been merged by jflory7

Thanks for Merging and helping along the way @jflory7 :)

Metadata