-
Notifications
You must be signed in to change notification settings - Fork 7
Add help articles on referencing and articles #16
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
Merged
Merged
Changes from all commits
Commits
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,26 @@ | ||
## Categories and post types | ||
|
||
In addition to just Q&A, here on Codidact each site can also add several different categories of posts. This is useful for different types of knowlege sharing, as well as for site activities and community building. These categories can contain different post types. | ||
|
||
**Post types** | ||
|
||
Currently, we have two main post types: Q&A (questions and answers), and articles. | ||
|
||
Q&A is what forms, in most cases, the majority of the content on the site. Both the default Q&A and Meta categories use the Q&A post type. | ||
|
||
One of the main technical differences between articles and Q&A is that articles can't be answered, as well as having a `/articles/` path in the post URL. (Q&A uses a `/questions/` path.) | ||
|
||
Articles can be used in several different ways. Some sites have a blog, where people can post about topics that are of interest to that community, as well as site updates (and, really, whatever that site decides). Other sites use articles to post information that doesn't quite fit in a Q&A format - such as tutorials, reviews, or recommendations. | ||
|
||
**Categories** | ||
|
||
By default, all sites start out with two main category types: Main Q&A, which is where the main Q&A content for the site goes; and Meta, where people can discuss the site itself. | ||
|
||
In additon, many sites have additional categories. For instance, [Writing](https://writing.codidact.com) has a category for Writing Challenges, [Cooking](https://cooking.codidact.com) has a category for sharing Recipes, and [Codidact Meta](https://meta.codidact.com) has a category for a [site Blog](https://meta.codidact.com/categories/30) (where the Codidact Team shares updates). | ||
|
||
A category can use the Q&A post type, such as Writing's writing challenges, where people post entries as answers to a question; or they can use an article post type, such as Cooking's recipes; or they can use both, and have both articles and Q&A allowed in that category. | ||
|
||
--- | ||
|
||
|
||
If your site doesn't currently have a blog or another category that you'd like to see, you can post a proposal in your site's Meta category with your arguments for why your community would benefit from adding other categories and what categories you'd like to add. |
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,18 @@ | ||
## Guidelines for referencing and quoting on Codidact sites | ||
|
||
When you're writing a post, referencing and quoting external material is a great way to back up your posts, provide sources, and increase the quality of what you're writing. There are, however, a few thing to keep in mind when quoting external material. | ||
|
||
**Referencing online material** | ||
|
||
When you're referencing or quoting material that can be found online (such as [Wikipedia](https://en.wikipedia.org/ "English Wikipedia") or similar), **please make sure to include a link**. | ||
Pay attention to what license the content is published under - for instance, Wikipedia licenses text under the [Creative Commons Attribution-ShareAlike 3.0 license](https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License), which requires attribution and a link back to the original source. | ||
|
||
|
||
**Referencing offline material** | ||
|
||
When quoting from offline material, such as a book, please make sure to always include at a very minimum the **title and author** of the work. Including a chapter number or page number when applicable is ideal. | ||
Be sure to only quote whatever text is relevant. While quoting for knowlege sharing usually falls under [Fair Use rules](https://en.wikipedia.org/wiki/Fair_use), which allows the use of copyrighted material, limiting the sharing of copyrighted works to only what's necessary for your post is in general a good idea. | ||
|
||
--- | ||
|
||
In any case, whether your original source is online or offline, **please *clearly* mark the quoted material as being quoted** from somewhere and is not your original content. This is done simplest with blockquote formatting (see the [formatting help](/help/formatting) for help with formatting). |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!