OpenFeign/feign

openfeign.github.io does not exist

Open

#773 opened on Aug 16, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (1,911 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (9,070 stars)
PR merge metrics
 (Avg merge 3d 8h) (59 merged PRs in 30d)

Description

The project has no presence other than this repository and the README. It would be beneficial to those coming to this project to have a destination with our documentation, release versions, and some simple Getting Started documentation outside of the README.

Contributor guide

Research direction
Create a GitHub Pages site using a static site generator like Jekyll to host documentation, release versions, and getting started guides. Explore the repository for existing documentation and config. Decide on a structure (e.g., docs folder or separate branch) and ensure the site is published at openfeign.github.io. Look at similar projects for inspiration.
Tech stack
java
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
static site generatorGitHub Pagesdocumentation tooling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70