Skip to content

Update documentation for decidim OAuth social provider#6607

Merged
Leusev merged 1 commit intodevelopfrom
doc/decidim_oauth_provider_already_has_its_builder
Oct 9, 2020
Merged

Update documentation for decidim OAuth social provider#6607
Leusev merged 1 commit intodevelopfrom
doc/decidim_oauth_provider_already_has_its_builder

Conversation

@tramuntanal
Copy link
Copy Markdown
Contributor

@tramuntanal tramuntanal commented Oct 6, 2020

🎩 What? Why?

Please describe your pull request.
This PR is to update the documentation related with the decidim omniauth social provider.

  • It moves the documentation for the provider into the docs/services/social_providers.md.
  • It directs the reader to the [omniauth-decidim](https://github.com/decidim/omniauth-decidim] module for documentation in how to configure the client. The documentation in omniauth-decidim repo has also been updated.
  • It also corrects some minor markdown linter errors in docs/getting_started.md.

📌 Related Issues

Link your PR to an issue

  • Related to #?
  • Fixes #?

Testing

Describe the best way to test or validate your PR.

📋 Checklist

🚨 Please review the guidelines for contributing to this repository.

  • CONSIDER adding a unit test if your PR resolves an issue.
  • ✔️ DO check open PR's to avoid duplicates.
  • ✔️ DO keep pull requests small so they can be easily reviewed.
  • ✔️ DO build locally before pushing.
  • ✔️ DO make sure tests pass.
  • ✔️ DO make sure any new changes are documented in docs/.
  • ✔️ DO add and modify seeds if necessary.
  • ✔️ DO add CHANGELOG upgrade notes if required.
  • ✔️ DO add to GraphQL API if there are new public fields.
  • ✔️ DO add link to MetaDecidim if it's a new feature.
  • AVOID breaking the continuous integration build.
  • AVOID making significant changes to the overall architecture.

📷 Screenshots

Please add screenshots of the changes you're proposing
Description

♥️ Thank you!

Copy link
Copy Markdown
Contributor

@ivan-mr ivan-mr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the documentation @tramuntanal. Seems to be ok.

@Leusev Leusev mentioned this pull request Oct 7, 2020
1 task
Copy link
Copy Markdown
Contributor

@Leusev Leusev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ok for me @tramuntanal 👍
We must bear in mind that there's another PR #6526 that reworks/sorts all this docs too..

@tramuntanal
Copy link
Copy Markdown
Contributor Author

thanks @Leusev for the warning!
You are right, it would be better to merge #6526 before this PR, and then we'll resolve conflicts

@andreslucena
Copy link
Copy Markdown
Member

You are right, it would be better to merge #6526 before this PR, and then we'll resolve conflicts

Whatever you feel it'd be better, as the one in #6526 is a huge PR what I've been doing is manual sync by converting new files:

git log --stat --pretty=short --graph docs/
kramdoc --format=GFM --output=docs/whatever.adoc --wrap=ventilate docs/whatever.md

@Leusev Leusev merged commit 44112f6 into develop Oct 9, 2020
@Leusev Leusev deleted the doc/decidim_oauth_provider_already_has_its_builder branch October 9, 2020 11:37
Leusev pushed a commit that referenced this pull request Dec 2, 2020
* Remove Markdown doc

* Add documentation with Antora (AsciiDoc format - .adoc)

Adds sections:
* configure
* customize
* develop
* install
* services

Also adds:
* a README explaining the relationship with the documentation repository
available in https://github.com/decidim/documentation
* antora metadata file so we can build these sections in the same website

* Fix Antora name for docs

* Rename advanced pages to Concerns

* Add Authorizations customize from module's README

* Move 'add_authorizable_action' to 'permissions'

* Move 'adding_fixtures_aka_dummy_content' to 'components'

* Move 'how_to_create_a_module' to 'components'

* Remove 'upgrading', now it's in 'update'

* Install guide: fix error in 'whatever' gem (it's 'whenever')

* Install guide: fix error in RAILS_ENV order in commands

* Install guide: fix command for open_data export

* Install guide: fix link to Contribution guide

* Develop guide: add example apps

* Architecture docs

Add first version of c4model diagrams with PlantUML

* https://c4model.com/
* https://plantuml.com/
* https://github.com/RicardoNiepel/C4-PlantUML

* Add some explanation of modules types (with Components link)

* Configure: ENV VARS and Initializer

This moves ENV VARS configuration docs to its own page.
We also create a new page for explaining Decidim's initializer settings
(config/initializer/decidim.rb). For the moment is mostly a copy paste with
nice formating, but the idea is to expand it.

* Sync "Make maps actually configurable" by @ahukkanen

Extracted from #6340

* Sync "Templates module" by @verarojman

Extracted from #6247

* Sync "Configure Decidim Bulletin Board" by @leio10

Extracted from #6420

* Sync "Add a task to fix locale issues" by @microstudi

Extracted from #6510

* Update versions in SECURITY.adoc

* Convert CONTRIBUTING.md to AsciiDoc

* Convert README.md to AsciiDoc

* Clarify CONTRIBUTING and links to docs site

* Remove Markdown linter CI

* Sync "Update documentation for `decidim` OAuth social provider" by @tramuntanal

Extracted from #6607

* Sync "Generate changelog entries" by @tramuntanal

Extracted from #6794

* Fix link in oauth.adoc

* Sync "Improve moderation panel" by @beagleknight

Extracted from #6677

* Removes trailing whitespaces

Co-authored-by: Oliver Valls <199462+tramuntanal@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants