#175 Update README content for 2018, add Antora directories to gitignore
Merged a year ago by jflory7. Opened a year ago by jflory7.

file modified
+4

@@ -1,3 +1,7 @@ 

  build

  cache

  public

+ 

+ # Antora-specific rules for preview documentation

+ _package/

+ _preview/

file modified
+53 -56

@@ -1,98 +1,95 @@ 

  Community + Operations = **CommOps**

  ====================================

  

- Community Operations, a.k.a. CommOps, addresss community infrastructure by

- providing tools, resources, and utilities for different sub-projects to improve

- communication across Fedora

  

+ ## What CommOps does

  

- ## What can I do here?

- 

- [File a ticket](https://pagure.io/fedora-commops/new_issue) to:

- 

- * Share information in one area of the Project with the rest

- * Requesting metrics about an area of the Project

- * More coming soon…

+ Community Operations (CommOps) provides tools, resources, and utilities for different sub-projects of Fedora to improve effective communication.

+ The following areas are examples of where CommOps focuses:

  

- You can also help us out too! Take a look at the [active issue

- list](https://pagure.io/fedora-commops/issues) and look for an issue assigned

- with a blank assignment, and feel free to take that task yourself. If there

- aren't any open issues, ask on our [mailing

- list](https://lists.fedoraproject.org/admin/lists/commops@lists.fedoraproject.org/)

- where you can help out.

+ * Work closely with [Fedora Community Action and Impact Coordinator](https://docs.fedoraproject.org/fedora-project/council/fcaic.html) to prioritize key focus areas

+ * Assist [Fedora Program Manager](https://docs.fedoraproject.org/fedora-project/council/fpgm.html) with release preparations

+ * Support preparation and execution of Fedora Elections

+ * Work with sub-projects and teams to improve on-boarding methods and practices

+ * Use metrics and data to improve understanding of Fedora community

+     * Support development of metrics tooling

+ * And more

  

- Because this is mainly a volunteer-staffed team, we may not notice all new issues immediately when they are filed. If you think an issue needs attention, try to contact the owner and see if they are working on it. If you don't hear from them within a week, you can probably take over the task.

+ Read more about us on [docs.fedoraproject.org](https://docs.fedoraproject.org/en-US/commops/ "Fedora Community Operations [CommOps] :: Fedora Docs").

  

- If you want to carry on a longer conversation with the team, you may want to join our ​[mailing list](https://lists.fedoraproject.org/admin/lists/commops@lists.fedoraproject.org/). 

  

+ ## What can I do here?

  

- ## IRC

- 

- * `#fedora-commops` on Freenode ([webchat](https://webchat.freenode.net/?channels=fedora-commops))

+ [File a ticket](https://pagure.io/fedora-commops/new_issue) for topics such as the following:

  

+ * Culture

+ * Elections

+ * Storytelling

+ * Metrics

+ * Supporting sub-projects

  

- ## Mailing Lists

+ You can also help us!

+ Read our [getting started guide](https://docs.fedoraproject.org/en-US/commops/contribute/join/) for new contributors to get involved.

+ After reviewing the guide, check out any open tickets marked as [**good first issue**](https://pagure.io/fedora-commops/issues?status=Open&tags=good+first+issue).

+ If you are not sure where to start, ask any questions or doubts on the [mailing list](https://lists.fedoraproject.org/admin/lists/commops@lists.fedoraproject.org/).

  

- * **[commops@lists.fedoraproject.org](https://lists.fedoraproject.org/admin/lists/commops@lists.fedoraproject.org/)**: General mailing list for all things CommOps-related

- * **[social-media@lists.fedoraproject.org](https://lists.fedoraproject.org/admin/lists/social-media@lists.fedoraproject.org/)**: The answer to "we should totally post this to social media!"

- * **[fedoramagazine-tips@lists.fedoraproject.org](https://lists.fedoraproject.org/admin/lists/fedoramagazine-tips@lists.fedoraproject.org/)**: Reader ideas and opinions about what to write about in the Fedora Magazine (evaluate pulse of the community)

+ If you think an issue needs more urgent attention, contact the ticket assignee and see if they are working on it.

+ If you don't hear from them within a week, you can take ownership of the task.

+ Because this team is staffed mostly by volunteers, we may not notice new issues immediately when they are filed.

  

  

- ## Things we help with

+ ## Where to find CommOps

  

- Specific details of each of these areas is found on our [wiki page](https://fedoraproject.org/wiki/CommOps).

+ Get in touch with us!

+ You can find us in [**these places**](https://docs.fedoraproject.org/en-US/commops/#find-commops).

  

- * Unified messaging

- * Curating a queue of "stories"

- * Badges Requests

- * New Contributor Onboarding via [Fedora Hubs](https://fedoraproject.org/wiki/Fedora_Hubs)

- * Wiki

- * Internal Communications

- * Code of Conduct and [Diversity](https://fedoraproject.org/wiki/Diversity)

- * Metrics

- * Voter Turnout

- * Release Notes

  

  ## CommOps Documentation

  

- Please report Issues and submit Pull Requests for **Content Fixes** here.

- Never done a pull request (or "PR")? Here's the [Pagure documentation for

- Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html).

+ Please report issues and submit pull requests for **Content Fixes** to [Fedora CommOps documentation](https://docs.fedoraproject.org/en-US/commops/) here.

+ General appearance issues and publishing issues should be reported against the [publishing software](https://pagure.io/fedora-docs/docs-fp-o).

  

+ Never done a pull request (or "PR")?

+ See the [GitHub Guides](https://guides.github.com/) for getting started with git.

+ If you already know git, see the [Pagure documentation for Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html) on how to submit contributions on pagure.io.

  

- General appearance issues and publishing issues should be reported against

- the [publishing software](https://pagure.io/fedora-docs/docs-fp-o).

  

  ### How to edit these documents

  

- All of this is written in AsciiDoc. It's a simple mostly-plain-text

- markup language. You may want to look at:

+ Content for the CommOps documentation is stored [in this repository](https://pagure.io/fedora-commops/tree/).

+ Source content is written in [AsciiDoc](http://asciidoc.org/).

+ See these resources for help using AsciiDoc:

+ 

+ * [AsciiDoc Syntax - Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)

+ * [AsciiDoc Recommended Practices](https://asciidoctor.org/docs/asciidoc-recommended-practices/)

+ 

+ <!--

  

+ Advanced topics for AsciiDoc:

  

- * [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)

- * [AsciiDoc Writer’s  Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/)

+ * [AsciiDoc Writer's  Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/)

  * [Antora Documentation](https://docs.antora.org/antora/1.0/page/)

  

+ -->

  

  ### Local preview

  

  This repo includes scripts to build and preview the contents of this repository.

  

- **NOTE**: Please note that if you reference pages from other repositoreis, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.

+ **NOTE**: Please note that if you reference pages from other repositories, those links will be broken in the local preview, as it only builds this repository.

+ If you want to rebuild the whole Fedora Docs site, see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.

  

- Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions.

+ Both of the below scripts use Docker, so ensure Docker is installed on your system before beginning (see below for Fedora instructions).

+ See below for further instructions.

  

  To build and preview the site, run:

  

- ```

- $ ./build.sh && ./preview.sh

+ ```bash

+ ./build.sh && ./preview.sh

  ```

  

- The result will be available at http://localhost:8080

+ The preview is hosted at [http://localhost:8080](http://localhost:8080).

  

- #### Installing docker on Fedora

+ #### Installing Docker on Fedora

  

- ```

- $ sudo dnf install docker

- $ sudo systemctl start docker && sudo systemctl enable docker

- ```

+ See the Fedora Developer Portal on [how to install Docker on Fedora](https://developer.fedoraproject.org/tools/docker/docker-installation.html "How to install Docker on Fedora")

This PR updates the README contents to be more accurate and helpful for someone visiting the repository. It also points more often to our docs site. Additionally, I also added more Antora preview directories to the gitignore.

Also worth noting, I converted the Markdown README to a convention of one sentence per line, which I copied from the AsciiDoc Recommended Practices. The intent of writing like this is so git / Pagure diff pages are more intuitive to read, when we're working with documentation in version control.

Metadata Update from @jflory7:
- Pull-request tagged with: team - commops, type - docs

a year ago

rebased onto 93ecbc1

a year ago

Pull-Request has been merged by jflory7

a year ago