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

Initial docs #142

Merged
merged 17 commits into from
Aug 31, 2020
Merged

Initial docs #142

merged 17 commits into from
Aug 31, 2020

Conversation

abcoathup
Copy link
Contributor

Initial docs based on READMEs and CLI and Lib docs.

Reference to import "@openzeppelin/upgrades/contracts/Initializable.sol"; will need to be updated once OpenZeppelin/openzeppelin-contracts#2335 merged and released.

network-files.adoc may need reworking.


Resolves #141

@abcoathup abcoathup requested a review from frangio August 26, 2020 09:40
@frangio frangio changed the base branch from master to docs August 26, 2020 21:57
Copy link
Contributor

@frangio frangio left a comment

Choose a reason for hiding this comment

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

Looks good!

Can you delete the API docs from the readmes, and also the FAQ, so we avoid that duplication?

I've changed this PR to go into a new branch until we publish the docs site, so that content remains available by browsing the repo until then.

docs/modules/ROOT/pages/network-files.adoc Show resolved Hide resolved
docs/modules/ROOT/pages/network-files.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/network-files.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/network-files.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/network-files.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/writing-upgradeable.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/writing-upgradeable.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/writing-upgradeable.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/writing-upgradeable.adoc Outdated Show resolved Hide resolved
@abcoathup
Copy link
Contributor Author

Can you delete the API docs from the readmes, and also the FAQ, so we avoid that duplication?

I removed API & FAQ.
Also removed How do the plugins work? (as this would have lots of links to docs FAQ) and Managing Ownership to avoid duplication.

abcoathup and others added 10 commits August 27, 2020 09:07
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
@abcoathup abcoathup requested a review from frangio August 27, 2020 02:02
Copy link
Contributor

@frangio frangio left a comment

Choose a reason for hiding this comment

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

We should also have links to the API docs, but it's okay if we don't do that in this PR.

README.md Show resolved Hide resolved
@abcoathup
Copy link
Contributor Author

@frangio what will the name of the docs URL be? Is it https://docs.openzeppelin.com/upgradesplugins or something else?

@abcoathup abcoathup requested a review from frangio August 28, 2020 04:39
@frangio
Copy link
Contributor

frangio commented Aug 28, 2020

According to the current config the URL will be https://docs.openzeppelin.com/upgrades-plugins.

name: upgrades-plugins
title: Upgrades
version: 1.x

So the FAQ for example would be https://docs.openzeppelin.com/upgrades-plugins/faq. Note that this is an unversioned link that will get redirected to the latest version (https://docs.openzeppelin.com/upgrades-plugins/1.x/faq).

Copy link
Contributor

@frangio frangio left a comment

Choose a reason for hiding this comment

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

I changed the API links since they were pointing to the wrong page.

Thank you @abcoathup!

@frangio frangio merged commit 42e7904 into OpenZeppelin:docs Aug 31, 2020
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.

Prepare content for publishing on docs site
2 participants