-
Notifications
You must be signed in to change notification settings - Fork 47
Skeleton blog post for introducing docs SDG and Namir #420
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
Closed
Closed
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5b2909c
Skeleton blog post for introducing docs SDG and Namir
jennaswa 4f7e2ff
Add project goal and highlight technical writer role
jennaswa 8115e59
Insert mission statement
jennaswa 8768ff2
Streamline language
jennaswa cb6ed8d
Change order of authors
jennaswa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| layout: post | ||
| title: Technical Writer for Streamlining MDAnalysis Docs and Resources | ||
| --- | ||
| <img | ||
| src="{{site.images}}/numfocus.png" | ||
| title="NumFOCUS Foundation" alt="NumFOCUS Foundation" | ||
| style="float: right; width: 10em;" /> | ||
|
|
||
| Thanks to the support of a [Small Development Grant](https://numfocus.org/programs/small-development-grants) awarded to MDAnalysis by [NumFOCUS](https://numfocus.org/), MDAnalysis is excited to start working with Namir Oues (@namiroues) as the technical writer for the funded project, "Unified and comprehensive documentation and learning resources for MDAnalysis". | ||
|
|
||
| MDAnalysis has an ever-expanding international community of users and developers. Thorough documentation and extensive learning resources -- such as tutorials and online workshop materials -- are publicly available to users under open source licenses; however, a considerable amount of overlap between the many resources (e.g., [website]({{ site.baseurl }}), [user guide]({{ site.docs.userguide }}), [docs]({{ site.docs.mdanalysis.url }}), [GitHub wiki]({{ site.github.wiki }})) can make it somewhat difficult for self-learners to find the information they need. | ||
jennaswa marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| As Technical Writer, [Namir](#meet-namir-oues) is tasked with consolidating the main website and additional MDAnalysis learning resources to guide users through a more streamlined workflow by removing duplication and outdated materials and more clearly delineating between developer-focused and user-focused content. A primary objective of this project is to enhance the user experience for newcomers to MDAnalysis and encourage continued growth in our user and developer communities. | ||
jennaswa marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Meet Namir Oues | ||
|
|
||
| <img | ||
| src="Picture Here" | ||
| title="Namir Oues" alt="Namir Oues" | ||
| style="float: left; width: 110px; height: 110px; border-radius: 20px; border: 15px solid white" /> | ||
|
|
||
| Please write a short (1-2 paragraphs) bio here. Feel free to include your affiliation(s) and any personal and/or professional interests. Please include any contact information you feel comfortable sharing publicly (e.g., GitHub/Discord handle, LinkedIn, website, blog, etc.) | ||
|
|
||
| ### Follow Along with this Project | ||
|
|
||
| We encourage you to see how this work is progressing and to share your thoughts and feedback. There are many ways to get involved, including joining the [`developers`](https://discord.com/channels/807348386012987462/808088023957897258) and [`documentation`](https://discord.com/channels/807348386012987462/1021430544543785021) channels on our [Discord server]({{ site.discord.url }}) (join using [this invite link]({{ site.discord.invite }})), engaging with the GitHub issue trackers for the [main MDAnalysis repo]({{ site.github.repo }}) and [MDAnalysis User Guide repo](https://github.com/MDAnalysis/UserGuide), and interacting on the [{{ site.mailinglists.discussion.name}} forum]({{ site.mailinglists.discussion.url }}). Ultimately, the goal of this project is to meet the needs of our community, so please do chime in with your input! | ||
|
|
||
| — @IAlibay @jennaswa @lilyminium @micaela-matta @orbeckst (Co-PIs/Project Personnel) @namiroues (Technical Writer) | ||
jennaswa marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.