Personal tools
You are here: Home Fedora Unity Project Posting How-To

Fedora Unity Project Posting How-To

by scott_glaser last modified Mar 13, 2008 11:45 AM

This post is going to document the proper method to generate a How-To Post for the Fedora Unity Project. The intent of this post is to ensure that all content follows a standard easy to read format that our users have become accustomed to seeing on our sites. When posting it is best to keep in mind who we are posting for, most of the users have limited experience with linux and the instructions need to reflect that by containing all the information needed to complete the task at hand.

Requirements

The first requirement is to establish an account by selecting "register" in the upper right corner of this page.

Once you have established an account, login utilizing the information for the account you have just established.

The place to start posting is in your folder, do this by selecting "my stuff" from the site menubar.

The next requirement is to utilize one of the posting templates.

The last requirement is to ensure that the information posted is simple and easy to follow

Doing the work

  1. Now that you are in your personal folder, select the "add item" pulldown and highlight and click on "page".
  2. This will start a new blank page.
  3. First fill in the Title section, this section is typically where you name or explain what your post is about.
  4. Then fill in the Description section, please use enough information so that the user reading the page understands what the post is about.
  5. Now comes decision time. Are the steps for this post the same for every version of Fedora Core? If so cut and paste the Single-Release-Template into the section Body Text. If the steps vary depending on the version of Fedora core cut and past the Multi-Release-Template into the section Body Text. The section of the templates that should be pasted start with the Requirement section of the template and ends with the Added Reading section.
  6. Now is the fun stuff, start with the Requirements section be sure to include prerequisite reading and/or all packages that this how-to is dependant upon.
  7. Then fill in the Doing the work section, use the ordered list layout. This is good as it walks the user through a numbered step sequence so if they have issues they can feed back input based on the step number. Also to save time link to content on the site whenever possible. For example if you need the user to open a terminal use the Internal Link function of the editor. That is the little chain icon. An example of this is below:
  8. Open a terminal
  9. Using internal links like this makes it cleaner and ensures that all posters follow the same steps to get to a terminal.
  10. Next if you have the user entering data as root, use the standard that we have set forth below:
  11. Enter:

    su -c '/sbin/iptables -I INPUT -p tcp --destination-port 6881:6999 -j ACCEPT'
  12. Using the su -c allows the user to execute only one command as root once they enter the root password. It also teaches the users other ways of executing commands as root without actually logging in as root and it tends to keep new users from corrupting their installation with unwanted commands.
  13. Make sure that the commands are entered in input boxes as in Step 9 of this post. This allows the user to cut and paste and eliminate the possibility of errors caused by typographical mistakes.
  14. Once you have all the steps from start through finish done in the Doing the Work section, it is time for the Troubleshooting section. This section is used to provide fixes for commonly encountered issues when performing the How-To.
  15. Next is the More Information section, this is the section where we have the Disclaimer and Copyright information. Those sections do not need to change. What does need to be completed in that section is the Added Reading section. This section is used to provide the links from which the post was derived and provide more information for the reader to go through should they wish to learn more. It is also used to provide links to bugzilla reports that cover the information in the post.
  16. Once you have completed filling out the template and feel it is complete select the "save" button at the bottom of the post, this will save the post into the site database. Also if you do not have time to complete the post in one session you can save at any point and continue at a later time.
  17. After you are confident that the post is ready to be published, select the "State" pulldown and then click on "submit". Then contact one of the Admin personnel via the "contact" button on the top right side of the site. In the Subject section place the title of your post, then add any amplifying information into the message section.
  18. Once an Admin has tested and approved of the post it will be moved to the content section of the site for which it is most appropriate. If the admin has issues with the post they will contact you and explain their issue with the content of the post. This may require you to edit or modify the post to conform with the standards of the site.
  19. Yes I know this sounds like a long drawn out process but it is required to ensure that the content is Correct and Complete for a new user .

More Information

Disclaimer

We test this stuff on our own machines, really we do. But you may run into problems, if you do, come to #fedora on irc.freenode.net

Added Reading

Document Actions
Log in


Forgot your password?
New user?