search

SFDO-Community-Sprints / CumulusCI-Process-for-Customers-and-Partners

How to go about setting up CumulusCI for Continuous Development and Distribution
BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

Recommend building project documentation in CumulusCI-Process-for-Customers-and-Partners wiki #1

Open jacebryan opened 5 years ago

jacebryan commented 5 years ago

Hi CumulusCI Process for Customers and Partners Team! Great job at the Detroit Sprint! :)

I wanted to submit an Issue to encourage you to host your project documentation in the CumulusCI-Process-for-Customers-and-Partners wiki.

To learn more about this process take a look at the About wikis Github article.

brennanbutlerRAD commented 5 years ago

I am looking at this now, so when there is a wiki there needs to be a home page right, what should that page be.

I will start working on a google doc to add you to. OH and eventually can we use the sidebar thing I like it. bitmoji

jacebryan commented 5 years ago

Yes - you will want a landing page (i.e. Home page) for the wiki. The good news is that when you create the first page in your Wiki (see image below) you will create the Home page. :)

WikiHomePage

You will want to keep the home page high level (i.e. just describe the content you've created along with links to the corresponding wiki pages that support process and diagrams.) The idea here is to provide high level value around the resources you are making available to the community. Remember - the README is a high level project overview. The wiki is where the people will go to learn more about your project. Think Table of Contents for your wiki home page.

Take a look at this Wiki example from a forked version of Outbound Funds: https://github.com/emilymorse/OutboundFunds/wiki

On that note I'd highly recommend reviewing Github's documentation around wikis: https://help.github.com/en/articles/about-wikis

Here are a few additional resources from Github that should help:

Github Guides https://guides.github.com/ Video Guides https://www.youtube.com/githubguides Github Help https://help.github.com/en

In the end how you structure the wiki is up to you and I am totally willing to give feedback on your Google doc outline. :)

Also - you need to teach me how to make a Bitmoji. The last one I made didn't look like me at all lol

brennanbutlerRAD commented 5 years ago

My little OCD self has just realized when building out the WIKI pages, that they are not in the same order as the list. I have been trying to find a way to make them line up with how the home page is organized (Same Order) and I am not able to. Is there a secret I am not aware of?

jacebryan commented 5 years ago

@brennanbutlerRAD - Totally hear ya on that! Take a look at this thread: https://stackoverflow.com/questions/39396362/github-wiki-pages-sort-order

Lots of options here.

Let me know which one you decide to go with!

brennanbutlerRAD commented 5 years ago

Thanks, Jace, reviewing it now. I am thinking the sidebar will be the simplest way to go.