Skip to content

docs: base documentation #250

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

Merged
merged 8 commits into from
Dec 6, 2021
Merged

docs: base documentation #250

merged 8 commits into from
Dec 6, 2021

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

Created skeleton of documentation using the Python version as reference.

Includes:

  • Homepage (see differences below)
  • Core modules (tracer, metrics, logger)
  • Analytics script + updated runtime key
  • Medias & folder structure
  • MKDocs config file (mkdocs.yml)
  • Details on how to run it locally in CONTRIBUTING.md
  • NPM scripts to run locally

Differences:

  • Homepage sections empty/removed/amended:
    • Install
    • Lambda Layer
    • Quick getting started
    • Features (contains only relevant ones)
    • Environment variables (contains only relevant ones)
    • Debug mode
  • Scripts to run locally rely on npm rather than make like in Python

How to verify this change

Build docker container locally & run docs, see package.json scripts.

Related issues, RFCs

#152

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

Breaking change checklist

N/A

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi added this to the beta-release milestone Nov 30, 2021
@dreamorosi dreamorosi linked an issue Nov 30, 2021 that may be closed by this pull request
5 tasks
@dreamorosi dreamorosi added the documentation Improvements or additions to documentation label Nov 30, 2021
@dreamorosi dreamorosi self-assigned this Nov 30, 2021
saragerion
saragerion previously approved these changes Dec 1, 2021
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

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

Some minor comments / questions, but it already looks good

saragerion
saragerion previously approved these changes Dec 1, 2021
@ijemmy
Copy link
Contributor

ijemmy commented Dec 2, 2021

I've added the CHANGELOG.md file. Mkdocs will break without it.

ijemmy
ijemmy previously approved these changes Dec 2, 2021
@ijemmy ijemmy requested a review from saragerion December 2, 2021 15:44
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

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

LGTM

@ijemmy ijemmy merged commit 0a83904 into main Dec 6, 2021
@ijemmy ijemmy deleted the docs/base-documentation branch December 6, 2021 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: Publish documentation
3 participants