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.

Sign up for GitHub

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

Jump to bottom

State of documentation #29

Closed
ralphtheninja opened this issue Jun 11, 2018 · 23 comments
Closed

State of documentation #29

ralphtheninja opened this issue Jun 11, 2018 · 23 comments
Labels
documentation Improvements or additions to documentation

Comments

@ralphtheninja
Copy link
Member

ralphtheninja commented Jun 11, 2018 •
edited by vweevers
Loading

The state of README.md (style updated with level badge etc), CHANGELOG.md and UPGRADING.md.

EDIT (@ralphtheninja): Updated with LICENSE.md/CONTRIBUTORS.md/README.md which essentially means "There is a LICENSE.md file and a CONTRIBUTORS.md file, where LICENSE.md links to CONTRIBUTORS.md and README.md links to LICENSE.md according to new and simplified format in https://github.com/Level/level-js/tree/ce8d77c89f38e444b6951e890aa3b5e72a221aaf#license"

EDIT (@vweevers): Added tasks to remove contributors from package.json and to remove copyright headers from code.

Below is a summary of all repositories. Some of these are not actively maintained and some might be more or less irrelevant for other reasons, e.g. maybe we don't need UPGRADING.md for electron-demo etc.

Please comment and/or edit this post if you think that something should be archived or need special care.

  • abstract-leveldown
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • awesome
    • README.md (needs to be re-generated after level-js and level-browserify)
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • codec
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • concat-iterator
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • community
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • deferred-leveldown
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • electron-demo
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • encoding-down
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • errors
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • iterator-stream
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • leveldb.org
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • leveldown
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • leveldown-hyper
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-hyper
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-js
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-test
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-rocksdb
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-ttl
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • levelup
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-ws
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • mem
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • memdown
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • packager
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • rocksdb
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • subleveldown
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • lazy-open (archived)
    • README.md
    • CHANGELOG.md
    • ~~ UPGRADING.md~~
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-lmdb (to be archived)
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-mobile (to be archived)
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • leveldown-mobile (to be archived)
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-fstream (to be archived)
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-basho (archived)
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • level-browserify (archived)
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • typings (archived)
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
  • database (archived)
    • README.md
    • CHANGELOG.md
    • UPGRADING.md
    • LICENSE.md/CONTRIBUTORS.md/README.md
    • Remove contributors from package.json
    • Remove copyright headers from code
@vweevers
Copy link
Member

+1 to archiving not actively maintained repos

@vweevers
Copy link
Member

Except for typings, as I understand it that's a temporary home for typescript, and a work-in-progress.

@ralphtheninja
Copy link
Member Author

I think we should at least tweak the README of not actively maintained before archiving, it's quickly done.

@ralphtheninja
Copy link
Member Author

ralphtheninja commented Jun 11, 2018 •
edited
Loading

Lets make another pass at this later with LICENSE.md (which should link to ->) and CONTRIBUTORS.md. Also, README should end with the cleaner ## License header.

@ralphtheninja
Copy link
Member Author

Updated.

@vweevers vweevers mentioned this issue Jun 15, 2018
Closed
@vweevers
Copy link
Member

@ralphtheninja as part of this effort, should we also:

  1. Remove contributors from package.json
  2. Remove copyright headers from JS files

I think yes. See Level/levelup#587 (comment).

@ralphtheninja
Copy link
Member Author

@ralphtheninja as part of this effort, should we also:

Remove contributors from package.json
Remove copyright headers from JS files

I think yes. See Level/levelup#587 (comment).

Agreed.

@vweevers
Copy link
Member

Added.

@ralphtheninja
Copy link
Member Author

ralphtheninja commented Jun 21, 2018 •
edited
Loading

Funny enough, leveldown-hyper is the first project to tick all boxes 😄

@ralphtheninja
Copy link
Member Author

I ticked the boxes for irrelevant tasks, just to see the progress and what's really left to do.

@ralphtheninja
Copy link
Member Author

I archived the database repository.

@ralphtheninja
Copy link
Member Author

@vweevers I'm going to refer to LICENSE.md/CONTRIBUTORS.md/README.md as hallmark from now on, so if you see issues created mentioning hallmark, this is what I mean.

@ralphtheninja ralphtheninja mentioned this issue Jun 30, 2018
Open
@vweevers
Copy link
Member

Ticked typings.

@vweevers
Copy link
Member

vweevers commented Oct 21, 2018 •
edited
Loading

remark-cli had a major release but I couldn't see what changed at first glance. Dumping a list of greenkeeper PR's:

Edit: also added greenkeeper PRs for remark-git-contributors. We can tackle both by replacing remark-cli with hallmark.

@vweevers vweevers added the documentation Improvements or additions to documentation label Dec 9, 2018
@vweevers
Copy link
Member

vweevers commented Jan 4, 2019

I'm writing a script to do some of the above automatically across the board.

@vweevers
Copy link
Member

vweevers commented Jan 5, 2019 •
edited
Loading

Progress:

  • Create branch
  • Sort package.json
  • Add repository and homepage to package.json
  • Add 'level' to keywords
  • Add or upgrade hallmark
  • Add or upgrade level-community
  • Remove remark-* dependencies, remarkConfig and remark npm script
  • Add md file(s) to hallmark.ignore if they contain <a
  • Add hallmark --fix npm script
  • Add hallmark to npm test script
  • Add CONTRIBUTORS.md
  • Rename LICENSE file to LICENSE.md with standard format
  • Fix copyright year to be Math.min(current, initialCommitYear)
  • Update Licen(s|c)e heading in README.md
  • Add License heading if missing
  • Exclude leveldown and rocksdb to keep LevelDB and Snappy credits
  • Add CONTRIBUTORS.md to files if present in package.json
  • Add CONTRIBUTING section to README.md
  • Run hallmark --fix
  • Fix Do not use upper-case characters in definition labels in CHANGELOG.md
  • Push branch

Manual tweaks left:

@vweevers
Copy link
Member

vweevers commented Jan 5, 2019

@ralphtheninja prepare yourself for 28 PRs 😄

@ralphtheninja
Copy link
Member Author

@ralphtheninja prepare yourself for 28 PRs smile

😆

This was referenced Jan 5, 2019
Merged
Merged
Merged
Merged
Merged
Merged
This was referenced Jan 6, 2019
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
@ralphtheninja
Copy link
Member Author

@vweevers We should also take care to publish patches so npm gets the new updated README and also since keywords might have been updated etc.

@vweevers
Copy link
Member

vweevers commented Jan 7, 2019

Sure

@vweevers
Copy link
Member

vweevers commented Mar 31, 2019 •
edited
Loading

Only two more to go: errors and level-ttl.

Only one more to go: level-ttl.

@vweevers
Copy link
Member

Closing because for the 1 remaining task we have Level/level-ttl#108.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ralphtheninja @vweevers