Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: major documentation refresh #3475

Merged
merged 63 commits into from Jun 15, 2022
Merged

feat: major documentation refresh #3475

merged 63 commits into from Jun 15, 2022

Conversation

james-d-elliott
Copy link
Member

@james-d-elliott james-d-elliott commented Jun 4, 2022

ToDo:

  • Check how this looks when deployed via Netlify using this branch.

@authelia
Copy link

authelia bot commented Jun 4, 2022

Artifacts

These changes are published for testing on Buildkite, DockerHub and GitHub Container Registry.

Docker Container

  • docker pull authelia/authelia:refactor-docs
  • docker pull ghcr.io/authelia/authelia:refactor-docs

@codecov
Copy link

codecov bot commented Jun 4, 2022

Codecov Report

Merging #3475 (e900a41) into master (c020697) will decrease coverage by 0.89%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3475      +/-   ##
==========================================
- Coverage   66.16%   65.27%   -0.90%     
==========================================
  Files         251      251              
  Lines       14688    14688              
  Branches      399      399              
==========================================
- Hits         9719     9587     -132     
- Misses       4407     4548     +141     
+ Partials      562      553       -9     
Flag Coverage Δ
backend 65.31% <ø> (-1.05%) ⬇️
frontend 63.49% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
internal/commands/hash.go 22.22% <0.00%> (-55.56%) ⬇️
internal/configuration/sources.go 69.69% <0.00%> (-18.19%) ⬇️
web/src/services/SignOut.ts 85.71% <0.00%> (-14.29%) ⬇️
internal/commands/storage_run.go 27.53% <0.00%> (-8.56%) ⬇️
internal/regulation/regulator.go 94.00% <0.00%> (-6.00%) ⬇️
internal/storage/migrations.go 51.12% <0.00%> (-3.01%) ⬇️
internal/storage/sql_provider_schema.go 42.42% <0.00%> (-2.60%) ⬇️
internal/commands/certificates.go 52.67% <0.00%> (-1.53%) ⬇️
internal/storage/sql_provider.go 49.30% <0.00%> (-0.35%) ⬇️
web/src/views/LoginPortal/LoginPortal.tsx 94.17% <0.00%> (+0.97%) ⬆️
... and 2 more

docs/data/docs-versions.yml Outdated Show resolved Hide resolved
docs/data/docs-versions.yml Outdated Show resolved Hide resolved
@netlify
Copy link

netlify bot commented Jun 6, 2022

Deploy Preview for authelia-staging canceled.

Name Link
🔨 Latest commit e900a41
🔍 Latest deploy log https://app.netlify.com/sites/authelia-staging/deploys/62a96cd97dc5080009adc895

@james-d-elliott james-d-elliott force-pushed the refactor-docs branch 8 times, most recently from 91fca96 to 1a545ea Compare June 13, 2022 01:37
@james-d-elliott james-d-elliott force-pushed the refactor-docs branch 2 times, most recently from 3825cce to 43ed585 Compare June 13, 2022 06:36
@james-d-elliott james-d-elliott changed the title docs: major refresh feat: major documentation refresh Jun 14, 2022
@james-d-elliott james-d-elliott merged commit b2c60ef into master Jun 15, 2022
@james-d-elliott james-d-elliott deleted the refactor-docs branch June 15, 2022 07:51
Comment on lines +15 to +31
[Pull Request] guidelines are in place in order to maintain consistency and clearly communicate our process for
processing merges into the [master] branch.

## Overview

* Ensure the `Allow edits by maintainers` checkbox is checked due to our [Squash Merge](#squash-merge) policy
* Ensure you avoid a force push due to our [Squash Merge](#squash-merge) policy and [Review](#review) complications

## Squash Merge

Every [Pull Request] will be squash merged into [master]. This requires the [Pull Request] branch to be up-to-date with
the [master] branch.

## Review

Every [Pull Request] will undergo a formal review process. This process is heavily complicated if you rewrite history
and/or perform a force push, especially after a maintainer has started a review. As such we request that any action that
Copy link
Contributor

Choose a reason for hiding this comment

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

You've got various invalid link references here that just render as [Pull Request] for example.

The final sentence also looks incomplete.


I didn't see much context regarding what this content may have been previously, and didn't want to wade through the commit history or review discussion to try trace back the original content (if there was any for it).

Just thought I'd bring it to your attention :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants