1
0
mirror of synced 2026-01-27 15:02:14 -05:00
Files
docs/README.md
Meg Bird 754ceda517 [Universe] Discussions Public Beta (#16547)
* Update README

* create structure for discussions landing page

* is everything broken

* [Universe] Dark mode (#16545)

* Fix title

* Add Discussions product

* Correct title

* Correct title

* Move quickstart article

* Move quickstart back out into article

* Add and incorporate reusables

* Move information about search

* Draft conceptual information

* Draft best practices

* Draft further reading

* Draft product introduction

* Draft introduction

* Add author metadata

* Pluralize

* Fix typos

* Add introduction

* Bump Octicons

* Add some reusables

* Add images

* Revise article

* Draft article

* Change word

* 🔪 the gerund

* Add reusable

* Revise introduction

* Revise list

* Simplify

* Revise reusable

* Fix reusable; add context

* Rename reusable

* Deduplicate conceptual information

* 🔪 gerund

* Add link to further reading

* Move link and dispose of tip

* Delete space

* Add images

* Add conceptual section

* Add word

* Delete newline

* Revert package.json to state on main

* Tweak images

* Draft article

* Add product name

* Remove beta note

* Use product name for future-proofing

* Begin adding search information

* Fix copypasta

* little edits

* build out a bit more of the guides content

* Don't mention integrations for now

* Escape quote

* Remove authorship information for new defaults

* Finish drafting article

* Replace encoded character to match description

* Revise away inline link

* Accommodate 'for more information' in reusable

* Fix links

* Fix one last bit of copypasta

* Update indices

* Temporarily remove heading

* Update introduction

* Add new article 💀

* Remove commits from universe-2020-megabranch

* Add article 💀

* update with a very rough draft

* Add content about collaboration options to "About repositories"

* Add content about discussions to "About issues"

* Reorder content

* Add is:discussion query

* update with a few mmore fleshed out sections

* update with more structure

* Add reusable

* Add screenshots

* Clear way for actual procedural

* Discussions landing page "Communities" section (#16692)

* Make button Overview-able

* Make card filtering more extensible

* Guard for missing attributes

* Use arbitrary dataset attributes

* Add section with discussions-community-card

* Tweak show more button behavior

* Conditionally show "Show more"

* Add beta_product frontmatter/label

* Remove beta callout note

* Hide changelog with no items

* Finish importing community info

* Fix borked markup

* Omit search abr

* Two columns should actually be two columns

* Use org image, change card layout

* Add two more examples

* Fix title

* Escape quote

* Escape another quote

* Draft article

* Lower case

* Relocate conceptual information

* Update qualifier name

* Draft article

* Add conceptual information and links

* Remove duplicative section

* Fix copypasta

* Revise reusable

* Update link

* Add content on categories

* Lint the discussions YAML file

* Update introduction and permissions

* 

* Reusablize; fix link

* more planning content stuff

* Escape quotes

* Align prerequisites

* Soften

* Clean up prerequisites

* Fix titles; version; add screenshot

* Fix links

* Actually fix links

* Use better variable

* Mention pinning

* Update screenshots

* Add screenshot

* forgot to committ

* update with reusable

* add that screenshot

* beef up landing page a bit

* remove extra space

* messed that up

* fix hardcoded linkks weirdo

* fix tests

* update with permissions content

* update with placeholder

* filter out standalone category files from test

* update

* update @becca's  feedback

* update with more feedback

* so many updates

* fix links

* fix some more tests

* flesh some more things out

* update with further reading blah blah

* fix some things

* remove the gate-features label for beta ship only

* Add discussions video to product landing page (#16759)

* Add discussions video placeholder

* This might work maybe

* fix tests

* apply all of @becca's and @lecoursen's  feedback ❤️

* rename to fix test

* Revert "Add discussions video to product landing page (#16759)"

This reverts commit 2247e5d0881ca6b36cee421218e8341a7cc12ac7.

* update with test fix

Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Jason Etcovitch <jasonetco@github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
2020-12-07 15:00:35 -07:00

3.5 KiB

GitHub Docs

This repository contains the documentation website code and Markdown source files for docs.github.com.

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.

In this article:

Contributing

Start contributing right now:

We accept a lot of different contributions, including some that don't require you to write a single line of code.

Click make a contribution from docs

As you're using the GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on make a contribution to navigate directly to that article in the codebase, so that you can begin making your contribution.

Open an issue

If you've found a problem, you can open an issue using a template.

Solve an issue

If you have a solution to one of the open issues, you will need to fork the repository and submit a pull request using the template that is visible automatically in the pull request body. For more details about this process, please check out Getting Started with Contributing.

Join us in discussions

We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in discussions.

And that's it!

That's how you can get started easily as a member of the GitHub Documentation community.

If you want to know more, or you're making a more complex contribution, check out Getting Started with Contributing.

There are a few more things to know when you're getting started with this repo:

  1. If you're having trouble with your GitHub account, contact Support.
  2. We do not accept pull requests for translated content - see CONTRIBUTING.md for more information.

READMEs

In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:

License

The GitHub product documentation in the assets, content, and data folders are licensed under a CC-BY license.

All other code in this repository is licensed under a MIT license.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.