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

Jump to bottom

Update citation CFF docs #11510

Merged
merged 4 commits into from Nov 3, 2021
Merged

Update citation CFF docs #11510

merged 4 commits into from Nov 3, 2021
+22 −12

Conversation

Reviewers

@arfon arfon

@mchammer01 mchammer01

Assignees
No one assigned
Labels
content hacktoberfest-accepted ready to merge
Projects
Docs team reviews
Done
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

Update CFF types in the citation documentation.
4 participants
@hainesr @arfon @ramyaparimi @mchammer01
@hainesr
Copy link
Contributor

@hainesr hainesr commented Oct 28, 2021 •
edited
Loading

Why:

Closes #11509

What's being changed:

I've updated the table of mappings between CFF and BibTeX/APA to cover more cases and give more detailed information.

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")
hainesr added 3 commits Oct 28, 2021
@hainesr
VS Code removed whitespace errors.
45f6528
@hainesr
Update the CFF citation table.
02c7545 
Add more CFF types and their mappings to BibTeX types. Also note the APA
annotation, if there is one.
@hainesr
Update note about citing a dataset.
9f89c5e 
This makes it slightly more clear that `dataset` is a top-level type.
@welcome
Copy link

@welcome welcome bot commented Oct 28, 2021

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

Loading

@github-actions github-actions bot added this to Triage in Docs team reviews Oct 28, 2021
@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Oct 28, 2021 •
edited
Loading

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Staging Production What Changed
content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md Modified Original

Loading

@hainesr hainesr mentioned this pull request Oct 28, 2021
Closed
@arfon
Copy link
Contributor

@arfon arfon commented Oct 28, 2021

⚡ thanks for this @hainesr! This was on my todo list too but hadn't quite bubbled to the top yet :-)

GitHub folks – I'd like to do some verification on our side before we merge this but overall, this looks like a good change.

Loading

@ramyaparimi
Copy link
Collaborator

@ramyaparimi ramyaparimi commented Oct 28, 2021

@hainesr
Thanks so much for opening a PR! I'll get this triaged for review ⚡

Loading

@lecoursen lecoursen moved this from Triage to Technical review needed-Hacktoberfest in Docs team reviews Oct 29, 2021
@mchammer01 mchammer01 self-requested a review Nov 1, 2021
@mchammer01
Copy link
Contributor

@mchammer01 mchammer01 commented Nov 1, 2021

👋🏻 - I'll review this on behalf of Docs.

Loading

mchammer01
mchammer01 approved these changes Nov 1, 2021
View changes
Copy link
Contributor

@mchammer01 mchammer01 left a comment

@hainesr 👋🏻 - LGTM from an editorial point of view ✨
I'll let @arfon and team comment on the technical accuracy, and perform the required verifications.

Loading

@mchammer01 mchammer01 changed the title Update citation CFF docs [Do not merge: awaiting technical review] - Update citation CFF docs Nov 1, 2021
arfon
arfon approved these changes Nov 3, 2021
View changes
Copy link
Contributor

@arfon arfon left a comment

@mchammer01 - verified these all behave as expected in production.

Thanks for substantially improving the docs here @hainesr ✨

Loading

@mchammer01 mchammer01 changed the title [Do not merge: awaiting technical review] - Update citation CFF docs Update citation CFF docs Nov 3, 2021
@mchammer01
Merge branch 'main' into update-citation-cff-docs
bf1efb7
@docubot docubot moved this from Technical review needed-Hacktoberfest to Triage in Docs team reviews Nov 3, 2021
@mchammer01 mchammer01 enabled auto-merge Nov 3, 2021
@mchammer01 mchammer01 merged commit 8eb5643 into github:main Nov 3, 2021
28 checks passed
Loading
Docs team reviews automation moved this from Triage to Done Nov 3, 2021
@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Nov 3, 2021

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Loading

@hainesr hainesr deleted the update-citation-cff-docs branch Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment