Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Fix ability to edit pages via GitHub edit link #110

Merged
merged 6 commits into from
Sep 16, 2022
Merged

Fix ability to edit pages via GitHub edit link #110

merged 6 commits into from
Sep 16, 2022

Conversation

tpdorsey
Copy link
Contributor

@tpdorsey tpdorsey commented Sep 16, 2022

Summary

Fix misconfigured edit path to enable submitting edits via the "Pencil" edit link.

In addition:

  • Adds yaml frontmatter to doc pages
  • Frontmatter includes a note indicating that API pages are generated from docstrings in source files. This gives some indication to a user who wants to edit the API docs, but selects the edit pencil and finds a basically blank page.

Relevant Issue(s)

Checklist

  • Summarized PR's changes in the Unreleased section of the CHANGELOG.md

@tpdorsey tpdorsey added the documentation Improvements or additions to documentation label Sep 16, 2022
Copy link
Member

@desertaxle desertaxle left a comment

Choose a reason for hiding this comment

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

Thanks @tpdorsey! I have one suggestion for the README, but other than that this looks great!

README.md Outdated
Comment on lines 1 to 8
---
description: prefect-aws provides pre-built Prefect tasks for working with Amazon Web Services.
tags:
- overview
- getting started
- installation
- examples
---
Copy link
Member

Choose a reason for hiding this comment

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

This section gets rendered as a table by GitHub:
Screen Shot 2022-09-16 at 10 13 03 AM

I think the best course of action would be to inject this section into this page into the gen_refs script that allows us to use README.md as the index page for our docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah I see my mistake here. We should remove this from the readme. My bad. It's fine on the other pages.

docs/batch.md Outdated Show resolved Hide resolved
docs/client_waiter.md Outdated Show resolved Hide resolved
docs/credentials.md Outdated Show resolved Hide resolved
docs/ecs.md Outdated Show resolved Hide resolved
docs/s3.md Outdated Show resolved Hide resolved
docs/secrets_manager.md Outdated Show resolved Hide resolved
Co-authored-by: Alexander Streed <desertaxle@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants