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

Create background docs that will eventually be linked into a master list #99

Open
Grammaresque opened this issue Oct 6, 2024 · 6 comments
Assignees
Labels
hacktoberfest This issue or pull request is ideal for GitHub's Hacktoberfest event tag: content Additions to (or modifications of) content in the repository tag: good first issue Good for newcomers

Comments

@Grammaresque
Copy link
Contributor

Grammaresque commented Oct 6, 2024

To resolve this issue please do the following:

  1. Review CONTRIBUTING.md for how to contribute to this repo. Notably, submit files against the development branch of wiki.rockylinux.org rather than directly to main.
  2. Check out the existing linked reports in the directory event-reports directory to get an idea of the expected standard of what you are about to do. Choose the name of an event that does not yet have a linked report.
  3. Examine file doc/team/community/event-reports/event-report.template.
  4. Toward the upper right of the box, click the two overlapping boxes to copy the raw file.
  5. Move up one directory into docs/team/community/event-reports.
  6. Now move to this directory in your own forked repo, in the development branch.
  7. Toward the upper right of the box, click Add File > Create New File.
  8. Paste the template into this window.
  9. Name the document of the event you chose, using the naming convention [last two digits of year][acronym or short name of event].md
  10. In the meta information, change the title to the name of the event.
  11. Add author: [your name]
  12. Look up the event on the internet if you can. Populate the Event Title to be the name of the event.
  13. Under "Event Details" populate the fields of Date and Location.
  14. Under "Additional Resources" populate the event website (with hyperlink).
  15. If you attended the event, please add your name, social posts, and reflections in the last section.
  16. And that's it! Someone else will come back later and populate the document with report, highlights, etc.
  17. Commit the document with the description, "create event report document for [event name]" and submit PR against development branch of the wiki.rockylinux.org repo.

Thank you so much for your help! It may not seem like much but every piece helps.

This document has been assigned 2 times. It can be assigned 8 more times.

@Grammaresque Grammaresque added tag: content Additions to (or modifications of) content in the repository tag: good first issue Good for newcomers hacktoberfest This issue or pull request is ideal for GitHub's Hacktoberfest event labels Oct 6, 2024
@Satyasn01
Copy link

Assign

@Grammaresque
Copy link
Contributor Author

Thank you! LMK if you have any questions. the biggest key is to remember to submit the PR against development and not main. Otherwise hopefully I did a good job explaining the steps!

@johnny603
Copy link
Contributor

Can you assign me this? This will be my first no-code assignment for hacktoberfest

@johnny603
Copy link
Contributor

Click the link to template at the top of the page.

Error message:
404 - page not found
The
main

branch of
wiki.rockylinux.org

does not contain the path
docs/team/community/event-reports/template.md.

@nazunalika
Copy link
Member

Note: The template is not named with .md to prevent it from being interpreted as an actual page on the wiki. You are instead looking for doc/team/community/event-reports/event-report.template.

@Grammaresque
Copy link
Contributor Author

Thanks, I have updated the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest This issue or pull request is ideal for GitHub's Hacktoberfest event tag: content Additions to (or modifications of) content in the repository tag: good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants