From 3e9d1aebfd7eeab4b511d5c69875203cda89017c Mon Sep 17 00:00:00 2001 From: Justin W. Flory Date: Mar 02 2018 09:33:17 +0000 Subject: Add Fedora Planet doc, other misc. setup for on-boarding guide --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fa62c5c --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +## AsciiBinder-specific ignores +_preview +_package +*.swp +diag-*.png +diag-*.png.cache + +## Project-specific ignores +_l10n/pot/ diff --git a/_distro_map.yml b/_distro_map.yml index 30084f9..fb1ebbd 100644 --- a/_distro_map.yml +++ b/_distro_map.yml @@ -1,26 +1,11 @@ --- fedora: - name: Fedora - author: Fedora Documentation Project + name: Fedora On-boarding Guide + author: Fedora CommOps site: main site_name: Home site_url: https://docs.fedoraproject.org/ branches: - master-en-US: + master: name: Rawhide - dir: rawhide - f27-en-US: - name: 27 - dir: f27 - f26-en-US: - name: 26 - dir: f26 - mentored-projects: - name: Mentored Projects - dir: mentored-projects - Fedora-Council_council-docs: - name: Mission & Organization - dir: fedora-project - fedora-docs_quick-docs: - name: Quick Docs - dir: quick-docs + dir: master diff --git a/_topic_map.yml b/_topic_map.yml index e69de29..fd7c074 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -0,0 +1,30 @@ +# This configuration file dictates the organization of the topic groups and +# topics on the main page of the doc site for this branch. Each record +# consists of the following: +# +# --- <= Record delimiter +# Name: Origin of the Species <= Display name of topic group +# Dir: origin_of_the_species <= Directory name of topic group +# Topics: +# - Name: The Majestic Marmoset <= Topic name +# File: the_majestic_marmoset <= Topic file under group dir +/- +# - Name: The Curious Crocodile <= Topic 2 name +# File: the_curious_crocodile <= Topic 2 file +# - Name: The Numerous Nematodes <= Sub-topic group name +# Dir: the_numerous_nematodes <= Sub-topic group dir +# Topics: +# - Name: The Wily Worm <= Sub-topic name +# File: the_wily_worm <= Sub-topic file under / +# - Name: The Acrobatic Ascarid <= Sub-topic 2 name +# File: the_acrobatic_ascarid <= Sub-topic 2 file under / +# +# The ordering of the records in this document determines the ordering of the +# topic groups and topics on the main page. +--- +Name: Fedora On-boarding Guide +Dir: docs +Topics: + - Name: About this guide + File: index + - Name: Fedora Planet + File: fedora-planet diff --git a/docs/attributes.adoc b/docs/attributes.adoc new file mode 100644 index 0000000..f1baf4f --- /dev/null +++ b/docs/attributes.adoc @@ -0,0 +1,3 @@ +:FPLANET: link:http://fedoraplanet.org[Fedora Planet] +:FWIKI: https://fedoraproject.org/wiki +:YEAR: 2018 diff --git a/docs/fedora-planet.adoc b/docs/fedora-planet.adoc new file mode 100644 index 0000000..4c88791 --- /dev/null +++ b/docs/fedora-planet.adoc @@ -0,0 +1,108 @@ +include::docs/attributes.adoc[] + += Fedora Planet + +{FPLANET} aggregates various Fedora-related blog posts by contributors in one place. +Fedora contributors connect their https://en.wikipedia.org/wiki/Blog[blog] to the Planet and select specific posts to share on the Planet. +Fedora Planet is a helpful way to see what is going on inside of the Fedora community from different points of view. +It also expresses individual thoughts and personalities of the Fedora contributor community. + + +[[add-blog-planet]] +== Add your blog to Fedora Planet + +To add your blog to {FPLANET}, you must meet these requirements: + +* Sign the https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement] (FPCA) +* _CLA+1_: Belong to one or more groups in FAS footnote:[https://admin.fedoraproject.org/accounts/[Fedora Account System]] other than the FPCA group +* Add a public SSH key to FAS + +After verifying you meet the requirements, set up a specific category or tag on your blog for Fedora-related content. +This lets you filter specific content on your blog to share with the Fedora community. +It is discouraged to add the feed for your entire blog to the Fedora Planet. +Look up the documentation on how to create a feed for a category or tag for the blogging software you use. + +This guide also assumes you are using Fedora or a Linux-based operating system. +Follow these steps to add your blog to Fedora Planet: + +In your preferred plain text text editor, create a file like this:: +---- +[https://myblog.wordpress.com/category/fedora/feed/] # <1> +name = Your Name # <2> +face = https://example.com/profile-picture.jpg # <3> +---- +<1> *URL of your category-specific RSS/RSS2/Atom feed*, not your blog's URL +<2> *Your name* as you want it to appear +<3> Link to a *profile picture* to display alongside your posts on Fedora Planet + +The file should have no spaces or tabs before any of the lines +Also, you can have more than one entry in your `.planet` file. +Add another one below in the same format. + +Log into your {FWIKI}/Infrastructure/fedorapeople.org[fedorapeople.org] account (your account is created on first login):: +[source,bash] +---- +ssh fas-username@fedorapeople.org +---- + +Upload the file you created to your FedoraPeople account:: +[source,bash] +---- +scp /path/to/your-planet-file.txt fas-username@fedorapeople.org:~/.planet +---- + + +[[join-sub-planet]] +== Join a Sub-Planet + +A Sub-Planet is a special category on Fedora Planet. +A Sub-Planet focuses on a specific topic or kind of activity in Fedora. +Examples of the Sub-Planets we publish today are http://fedoraplanet.org/desktop[Desktop], http://fedoraplanet.org/design[Design], http://fedoraplanet.org/summer-coding[Summer Coding], and more. + +The instructions are the same but you must use a special file name inside your FedoraPeople account. +For example, if you want to add a category on your blog to the Desktop Sub-Planet, name the file `.planet.desktop` _instead of_ `.planet`. +For the Summer Coding Sub-Planet, this would be `.planet.summer-coding`. +For other Sub-Planets, use the URL for that Sub-Planet to name your file. + +If you're unsure if your content belongs in a Sub-Planet, ask the Mindshare Committee in irc://irc.freenode.net/#fedora-mindshare[#fedora-mindshare] on Freenode. + + +[[appropriate-material]] +== Appropriate material + +Fedora Planet is a place for Fedora contributors to express many ideas. +Not every idea needs to be promotional. +Some may be controversial, critical, or evoke other responses. +However, all posts to the Planet must adhere to the https://docs.fedoraproject.org/fedora-project/project/code-of-conduct.html[Fedora Code of Conduct]. + + +[[inappropriate-material]] +== Inappropriate material + +Inappropriate material may be removed from Fedora Planet without prior notice. + +Depictions of nudity, near-nudity, or other adult material:: +Sexual or adult material is not acceptable on the Fedora Planet. +These types of images have a negative effect on people's perception of the Fedora community and our values. +Our community is also diverse in age ranges and mature subject matter may not be appropriate for all ages in our community. +Therefore, they are also not appropriate for Fedora Planet, whether they are featured, used as a backdrop, or for other information. + +Use of material that violates the owner's copyright:: +Content that illegally violates copyright law is not permitted. +The Fedora Project seeks to spread free software and content. +We do this in part by promoting creation, use, and remixing of content that reflects our values (such as Creative Commons-licensed material). +Contributors must respect the copyrights of content creators when sharing to Fedora Planet. + + +[[additional-help]] +== Additional help + +The Fedora {FWIKI}/Infrastructure[Infrastructure Team] can help with technical problems or issues. +Reach out to them on their IRC channel on Freenode (irc://irc.freenode.net/#fedora-admin[#fedora-admin]) or their https://lists.fedoraproject.org/admin/lists/infrastructure.lists.fedoraproject.org/[mailing list]. + + +[[reporting-bugs]] +=== Reporting bugs + +If you find a bug, email the mailto:webmaster@fedoraproject.org[Websites team]. +Include a description, screenshot (if available), browser name and version, and what operating system you use.