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

docs: Added release notes and associated media for 0.38 #12022

Merged
merged 12 commits into from
Jan 6, 2021
Merged

docs: Added release notes and associated media for 0.38 #12022

merged 12 commits into from
Jan 6, 2021

Conversation

garden-of-delete
Copy link
Contributor

@garden-of-delete garden-of-delete commented Dec 12, 2020

SUMMARY

We would like to publish release notes with each major release. This is a first crack at sorting out the format for the release notes, starting with v0.38. These are the decision points that would benefit from feedback or objections, and will likely see iteration in future release notes:

  • Multimedia embedded in the release notes vs no multimedia
  • A single .md file with each new version's notes appended vs a separate .md file and directory for each release
  • Directory structure for release notes
  • How the release notes are linked to the top level README.md

The changes in this PR make a suggestion for each of those points.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A

TEST PLAN

No testing required, no changes to codebase.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Changes UI
  • Requires DB Migration.
  • Confirm DB Migration upgrade and downgrade tested.
  • Introduces new feature or API
  • Removes existing feature or API

@garden-of-delete garden-of-delete changed the title Added release notes and associated media for 0.38 docs: Added release notes and associated media for 0.38 Dec 12, 2020
@codecov-io
Copy link

codecov-io commented Dec 12, 2020

Codecov Report

Merging #12022 (153f124) into master (b75a1ec) will increase coverage by 0.23%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #12022      +/-   ##
==========================================
+ Coverage   66.91%   67.15%   +0.23%     
==========================================
  Files         994     1002       +8     
  Lines       49095    49231     +136     
  Branches     4983     5000      +17     
==========================================
+ Hits        32852    33059     +207     
+ Misses      16118    16049      -69     
+ Partials      125      123       -2     
Flag Coverage Δ
cypress 51.41% <ø> (+2.58%) ⬆️
javascript 61.25% <ø> (+0.04%) ⬆️
python 64.15% <ø> (-0.11%) ⬇️

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

Impacted Files Coverage Δ
...frontend/src/explore/components/OptionControls.tsx 75.60% <0.00%> (-24.40%) ⬇️
superset/db_engine_specs/mysql.py 79.59% <0.00%> (-12.25%) ⬇️
...explore/components/controls/AdhocFilterControl.jsx 65.64% <0.00%> (-2.90%) ⬇️
superset/cli.py 33.58% <0.00%> (-0.92%) ⬇️
superset/models/core.py 88.04% <0.00%> (-0.82%) ⬇️
...et-frontend/src/explore/reducers/exploreReducer.js 43.10% <0.00%> (-0.76%) ⬇️
superset/views/core.py 74.92% <0.00%> (-0.46%) ⬇️
superset/reports/dao.py 79.24% <0.00%> (ø)
superset/models/reports.py 100.00% <0.00%> (ø)
superset/async_events/api.py 100.00% <0.00%> (ø)
... and 57 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b75a1ec...153f124. Read the comment docs.

@benceorlai
Copy link

Thank Robert!

@mistercrunch
Copy link
Member

mistercrunch commented Dec 14, 2020

See it rendered here:
https://github.com/garden-of-delete/incubator-superset/blob/master/RELEASING/release-notes-0-38/release-notes-0-38.md

Comments:

  • file could be /release-notes-0-38/README.md so that github renders it when clicking on the folder
  • expecting to see images embedded in the release notes but I don't see any (?)

@garden-of-delete
Copy link
Contributor Author

garden-of-delete commented Dec 14, 2020

See it rendered here:
https://github.com/garden-of-delete/incubator-superset/blob/master/RELEASING/release-notes-0-38/release-notes-0-38.md

Comments:

  • file could be /release-notes-0-38/README.md so that github renders it when clicking on the folder
  • expecting to see images embedded in the release notes but I don't see any (?)

Addressed in most recent commits. New location:
https://github.com/garden-of-delete/incubator-superset/blob/master/RELEASING/release-notes-0-38/README.md

@garden-of-delete garden-of-delete marked this pull request as ready for review December 14, 2020 19:56
@benceorlai
Copy link

benceorlai commented Dec 15, 2020

@garden-of-delete Github's MD supports html tags, which gives you better control over the layout of images. Could you try something like:

<img src="/media/10800.gif" style="max-width:50%; border:1px solid grey;">

[List of backwards incompatible changes](https://github.com/apache/incubator-superset/blob/master/UPDATING.md#0380)

## Complete Changelog
For the complete chnagelog please see [apache/incubator-superset/CHANGELOG.md](https://github.com/apache/incubator-superset/blob/master/CHANGELOG.md)
Copy link
Member

Choose a reason for hiding this comment

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

spelling nit: changelog

@mistercrunch
Copy link
Member

Super nit-picky, but can we add borders to images? https://stackoverflow.com/questions/37349314/is-it-possible-to-add-border-to-image-in-github-markdown

Looks a bit rough here:
https://github.com/garden-of-delete/incubator-superset/tree/master/RELEASING/release-notes-0-38/

@mistercrunch
Copy link
Member

Trying the old close/reopen trick since Cypress is not complying

garden-of-delete and others added 12 commits December 23, 2020 17:14
Swapped out github style markdown embed tags with html style ones for more control.
Fixed a couple small inconsistencies in the feature tags
Seems like GitHub does not any but the most basic css in the embed tag.
Added a box around the images to clearly distinguish them from the whitespace. Images are now embedded on the same indentation tier as their associated bullet point.
@robdiciuccio
Copy link
Member

Nit: would love to see alt tags on the images for improved accessibility.

@robdiciuccio robdiciuccio merged commit 0e514c1 into apache:master Jan 6, 2021
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.0.0 labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants