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

OAuth2 documentation missing in API Reference #86

Closed
Rayne opened this issue Feb 21, 2017 · 6 comments
Closed

OAuth2 documentation missing in API Reference #86

Rayne opened this issue Feb 21, 2017 · 6 comments

Comments

@Rayne
Copy link
Member

Rayne commented Feb 21, 2017

Original issue: f3-factory/fatfree-core#175

@Rayne Rayne changed the title OAuth2 documentation missing in API Reference OAuth2 documentation missing in API Reference Feb 21, 2017
@Joseffb
Copy link
Member

Joseffb commented Feb 21, 2017 via email

@ikkez
Copy link
Member

ikkez commented Feb 21, 2017

That docomentation has not been written yet. Any voluntaries?

@emanwebdev
Copy link
Contributor

@ikkez ok please ; just direct me pls to the "How to contribute to a good documentation" entry door.

Help, since when we click on the "Edit" button we can see on the top-right corner of each & every page of F3.com , it leads to a 404 blank page @ view-source:https://fatfreeframework.com/3.6/edit/api-reference/main

? How to start the right way please

@Rayne Rayne closed this as completed Apr 5, 2017
@Rayne Rayne reopened this Apr 5, 2017
@Rayne
Copy link
Member Author

Rayne commented Apr 5, 2017

Looks like the edit button is broken.

I'm not @ikkez but here are the steps to add a new document to the API reference page:

  1. Create a new document. I would choose oauth2/main.md
  2. Add a link to the new document in the Web Services section at 3.6/api-reference/main.md

To test if everything is working as expected:

  1. Clone https://github.com/F3Community/F3com
  2. Replace the content directory with your F3com-data fork (I recommend symlinking)
  3. Open your clone of F3com in the browser

ikkez added a commit to f3-factory/F3com that referenced this issue Apr 5, 2017
ikkez added a commit to f3-factory/F3com that referenced this issue Apr 5, 2017
ikkez added a commit to f3-factory/F3com that referenced this issue Apr 5, 2017
@ikkez
Copy link
Member

ikkez commented Apr 5, 2017

all fixed. should be visible when @sn0opy does the next update

workflow to add a page is:

  • fork F3com and F3com-data to your account
  • clone your F3Com to local maschine
  • add your F3com-data fork as new remote to the submodule at content/
  • open http://localhost/F3com/create URL in your browser
  • save creation form, edit page, save
  • commit changed files to each repo.
  • push
  • create pull-request

once that's done and live, the edit button on the website will lead us to the github file in edit mode.
sooo easy 😅

@richardeth
Copy link

Dit someone alreadyc reated this?

@ikkez ikkez closed this as completed Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants