1
0
mirror of synced 2025-12-26 14:02:45 -05:00
Files
docs/data/ui.yml
Grace Park b98c83e924 REST operations sidebar (#26225)
* testing out a rest operations sidebar

* cleanup

* renamed 5 files

* renamed 5 files

* set redirect_from on 5 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 1 files

* renamed 2 files

* renamed 1 files

* renamed 4 files

* renamed 15 files

* renamed 2 files

* renamed 6 files

* renamed 1 files

* renamed 4 files

* renamed 7 files

* renamed 1 files

* renamed 3 files

* renamed 3 files

* renamed 1 files

* renamed 5 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 4 files

* renamed 1 files

* renamed 1 files

* renamed 2 files

* renamed 4 files

* renamed 1 files

* renamed 1 files

* renamed 1 files

* renamed 6 files

* renamed 6 files

* renamed 4 files

* move files

* adding more

* updating to add restcontext and start of removing data/reusables/rest-reference

* removed data/reusables

* add a RestMiniTocItem and updating the filtering to add a subcategory so all manually added H3s are in mini tocs in addition to operations

* remove console log

* [WIP]: REST New Proposal Sidebar (#26471)

* saving

* update sidebar

* remove console log

* update guides and overview

* import Category for category level rest pages

* update undefined restOperations

* update restOperationData category and subcategory levels"

* minor updates

* update get mini toc items function

* updating REST context for sidebar

* updating rest data

* remove console logs

* WIP: mini-toc-ing the sidebar

Co-authored-by: Robert Sese <rsese@github.com>

* A little cleanup

* Fix first subcategory link and add some comments

* updating anchor links in sidebar

* adding updates

* remove standalone

* update product and maptopic pages using article context

* add conditional link wrapper

* fix sidebar toggle and versions for enterprise admin

* update versions per subcategory

* Highlight sidebar link for current page

* Update miniToc hash links and hash change tracking

* fix unique key in CollapsibleSection

* Fix list markup

* remove title

* update permissions

* Hide minitocs on landing (#26594)

* hide minitocs on landing page

* simplify page components and remove minitoc from sidebar for guides/overview

* fix carats and category fix

* remove id

Co-authored-by: Grace Park <gracepark@github.com>

* updating content based on versions script check with the OpenAPI

* update script and content files

* update script and content/rest files

* update to add TocLanding

* update script

* update index files

* add codespaces repository-secrets

* remove openapi schema check script

* remove minitocs at the top

* add h2 about the {title} api

* fix tests/unit/openapi-schema.js

* Fix linting tests

* fix search/topics test

* fix tests/unit/pages test

* update rest/reference links in components

* run prettier

* Update components/rest/RestReferencePage.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update components/rest/RestReferencePage.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update tests/unit/openapi-schema.js

Co-authored-by: Rachael Sewell <rachmari@github.com>

* updating comment location

* remove dependabot override

* remove path-utils current product update for rest

* run linter

* remove dependabot.md and remove h2 heading on restreference

* update the correct product to rest for rest pages

* adding comments for updates to path-utils

* remove console log

* REST sidebar: handle legacy v3 redirects (#26686)

* Add script to handle legacy v3 REST redirects

* Run the script

* Handle a redirect to a redirect

* Update REST test URLs

* 'await' and test runs subcategory of checks

* Update REST URLs for routing/developer-site-redirects tests

* Update developer-redirects fixture with new REST URLs

* Resolve merge conflicts

* Update rest-redirects fixture with new REST URLs

* Fix broken links with REST pages re-org

* redirectTo could be undefined

* Fix script for posterity, can't redirect paths with hashes

* Remove invalid hash redirects

* Typically don't need to save one-off scripts

* Undo redirect changes (not necessary for handling v3 redirects)

* Remove script-added redirects

* Update old v3 redirects with new REST URLs

* No more GHES search indexing page

* 'org' not 'organization'

* Update fixture data for new REST URLs

* revert any content directory changes

Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>

* Adding test rest (#26750)

* add test to check openapi schema versions and content rest frontmatter versions

* update lib/redirects

* fix test and add error messages

* adding repository secrets

* adding repository-secrets.md

* Revert "update lib/redirects"

This reverts commit 3aafe28265764d5bc09c0c478c8e0ca099c8fbcf.

* remove lib/redirects changes and console logs

* Update lib/rest/index.js

Co-authored-by: Rachael Sewell <rachmari@github.com>

* update unique key

* Rest client side redirects (#26754)

* adding tags subcategory for the rest content repos category

* run prettier

* bug fix for anchor scrolls" (#26892)

* updating width size for rest reference page

* Rest sidebar consolidation (#26862)

* refactor sidebar

* fix articlecontext provider issue on rest product landing page for all versions

* fix a bug, create new component

* revert change to create new component and fix bug

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Set currentAnchor with a hashchange handler (#26923)

* Rest sidebar design tweaks (#26807)

* Rest sidebar design tweaks

* tweak color to subtle

* use muted color and margin for line

* update to design feedback

Co-authored-by: Grace Park <gracepark@github.com>

* Remove cheerio from rest-collapsible (#26948)

* remove cheerio from rest-collapsible

* update type

* adding endswith instead

* use productId instead

* one off edge case for secret-scanning

* Reorganize subcategory and category, Update pre -> div, Add RestContext (#26950)

* reorganize subcategory and category

* add RestContext

* update comment

* update for endpoints page

* add comment

* move object to restcontext

* remove effectiveDate in restcontext

* remove width calculation for rest reference page

* fix adding manual writer's minitocs to sidebar

* update with feedback

* update comment

* update isRestReferencePage

* remove page component and fix bug

* adding back rest/index.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* update content/rest"

* add back design tweak

* update to div

* update margins on rest api reference

* remove page component

* adding tests

* separate product from rest sidebar (#27065)

* separate product from rest sidebar

* Use ProductCollapsibleSections for product pages

* fix tests

Co-authored-by: Robert Sese <rsese@github.com>
Co-authored-by: Grace Park <gracepark@github.com>

* Rest sidebar translations (#27052)

* update translations

* remove general test

Co-authored-by: Robert Sese <rsese@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
2022-04-20 10:19:48 -07:00

228 lines
8.4 KiB
YAML

meta:
default_description: Get started, troubleshoot, and make the most of GitHub. Documentation for new users, developers, administrators, and all of GitHub's products.
header:
github_docs: GitHub Docs
contact: Contact
notices:
ghae_silent_launch: GitHub AE is currently under limited release. Please <a href="https://enterprise.github.com/contact">contact our Sales Team</a> to find out more.
release_candidate:
# The version name is rendered before the below text via includes/header-notification.html
' is currently available as a release candidate. For more information, see "<a href="/admin/overview/about-upgrades-to-new-releases">About upgrades to new releases</a>."'
localization_complete:
We publish frequent updates to our documentation, and translation of this page may still be in progress.
For the most current information, please visit the
<a id="to-english-doc" href="/en">English documentation</a>.
If there's a problem with translations on this page, please
<a href="https://github.com/contact?form[subject]=translation%20issue%20on%20docs.github.com&form[comments]=">let us know</a>.
localization_in_progress:
Hello, explorer! This page is under active development or
still in translation. For the most up-to-date and accurate information,
please visit our
<a id="to-english-doc" href="/en">English documentation</a>.
early_access: 📣 Please <b>do not share</b> this URL publicly. This page contains content about an early access feature.
release_notes_use_latest: Please use the latest release for the latest security, performance, and bug fixes.
# GHES release notes
ghes_release_notes_upgrade_patch_only: 📣 This is not the <a href="#{{ latestPatch }}">latest patch release</a> of Enterprise Server.
ghes_release_notes_upgrade_release_only: 📣 This is not the <a href="/enterprise-server@{{ latestRelease }}/admin/release-notes">latest release</a> of Enterprise Server.
ghes_release_notes_upgrade_patch_and_release: 📣 This is not the <a href="#{{ latestPatch }}">latest patch release</a> of this release series, and this is not the <a href="/enterprise-server@{{ latestRelease }}/admin/release-notes">latest release</a> of Enterprise Server.
sign_up_cta: Sign up
picker:
language_picker_default_text: Choose a language
product_picker_default_text: All products
version_picker_default_text: Choose a version
release_notes:
banner_text: GitHub began rolling these changes out to enterprises on
search:
need_help: Need help?
placeholder: Search GitHub Docs
loading: Loading
no_results: No results found
search_results_for: Search results for
no_content: No content
matches_displayed: Matches displayed
search_error: An error occurred trying to perform the search.
description: Enter a search term to find it in the GitHub Documentation.
label: Search GitHub Docs
homepage:
explore_by_product: Explore by product
version_picker: Version
toc:
getting_started: Getting started
popular: Popular
guides: Guides
whats_new: What's new
videos: Videos
all_changelogs: All changelog posts
pages:
article_version: 'Article version'
miniToc: In this article
contributor_callout: This article is contributed and maintained by
all_enterprise_releases: All Enterprise Server releases
about_versions: About versions
errors:
oops: Ooops!
something_went_wrong: It looks like something went wrong.
we_track_errors: We track these errors automatically, but if the problem persists please feel free to contact us.
page_doesnt_exist: It looks like this page doesn't exist.
support:
still_need_help: Still need help?
contact_support: Contact support
ask_community: Ask the GitHub community
survey:
able_to_find: Did this doc help you?
yes: Yes
no: No
comment_yes_label: Let us know what we do well
comment_no_label: Let us know what we can do better
optional: Optional
required: Required
email_placeholder: email@example.com
email_label: If we can contact you with more questions, please enter your email address
email_validation: Please enter a valid email address
send: Send
feedback: Thank you! We received your feedback.
not_support: If you need a reply, please contact support instead.
privacy_policy: Privacy policy
contribution_cta:
title: Help us make these docs great!
body: All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.
button: Make a contribution
or: Or,
to_guidelines: learn how to contribute.
products:
graphql:
reference:
implements: Implements
fields: Fields
arguments: Arguments
name: Name
type: Type
description: Description
input_fields: Input fields
return_fields: Return fields
implemented_by: Implemented by
values: Values
possible_types: Possible types
preview_notice: Preview notice
deprecation_notice: Deprecation notice
rest:
reference:
default: Default
name: Name
in: In
type: Type
description: Description
notes: Notes
parameters: Parameters
response: Response
status_codes: Status codes
http_status_code: HTTP Status Code
code_sample: Code sample
code_samples: Code samples
preview_notice: Preview notice
preview_notices: Preview notices
see_preview_notice: See preview notice
see_preview_notices: See preview notices
preview_header_is_required: This header is <strong>required</strong>
preview_notice_to_change: This API is under preview and subject to change
works_with_github_apps: Works with GitHub Apps
api_reference: REST API reference
footer:
all_rights_reserved: All rights reserved
terms: Terms
privacy: Privacy
security: Security
product:
heading: Product
links:
features: Features
security: Security
enterprise: Enterprise
case_studies: Case Studies
pricing: Pricing
resources: Resources
platform:
heading: Platform
links:
developer_api: Developer API
partners: Partners
atom: Atom
electron: Electron
github_desktop: GitHub Desktop
support:
heading: Support
links:
help: Help
community_forum: Community Forum
training: Training
status: Status
contact_github: Contact GitHub
company:
heading: Company
links:
about: About
blog: Blog
careers: Careers
press: Press
shop: Shop
product_landing:
quickstart: Quickstart
reference: Reference
overview: Overview
guides: Guides
code_examples: Code examples
search_code_examples: Search code examples
search_results_for: Search results for
matches_displayed: Matches displayed
show_more: Show more
explore_people_and_projects: Explore people and projects
sorry: Sorry, there is no result for
no_example: It looks like we don't have an example that fits your filter.
try_another: Try another filter or add your code example.
no_result: Sorry, there are no guides that match your filter.
learn: Learn how to add a code example
communities_using_discussions: Communities using discussions
add_your_community: Add your community
sponsor_community: GitHub Sponsors community
supported_releases: Supported releases
release_notes_for: Release notes for
upgrade_from: Upgrade from
browse_all_docs: Browse all docs
browse_all: Browse all
docs: docs
explore_release_notes: Explore release notes
view: View all
product_guides:
start_path: Start learning path
learning_paths: '{{ productMap[currentProduct].name }} learning paths'
learning_paths_desc: Learning paths are a collection of guides that help you master a particular subject.
guides: '{{ productMap[currentProduct].name }} guides'
more_guides: more guides
load_more: Load more guides
all_guides: 'All {{ productMap[currentProduct].name }} guides'
filter_instructions: Filter the guide list using these controls
filters:
type: Type
topic: Topic
all: All
guides_found:
multiple: '{n} guides found'
one: 1 guide found
none: No guides found
guide_types:
overview: Overview
quick_start: Quickstart
tutorial: Tutorial
how_to: How-to guide
reference: Reference
learning_track_nav:
prevGuide: Previous guide
nextGuide: Next guide
toggle_images:
off: Images are off, click to show
on: Images are on, click to hide
hide_single: Hide image
show_single: Show image
scroll_button:
scroll_to_top: Scroll to top