voxel51/fiftyone

[FR] Move documentation notebooks to the fiftyone-examples repository

Open

#756 opened on Jan 8, 2021

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Python (400 forks)batch import
documentationenhancementgood first issue

Repository metrics

Stars
 (4,021 stars)
PR merge metrics
 (PR metrics pending)

Description

Proposal Summary

Documentation notebooks should be kept in the fiftyone-examples repository to reduce the size of the main repository. The documentation build process would have to be updated.

Motivation

Maintain a reasonable repository size.

Contributor guide

Research direction
Explore the fiftyone examples repository structure, understand the documentation build process in the main repo, and identify the steps needed to relocate notebooks and update build configuration.
Tech stack
python
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75