Skip to content

Commit

Permalink
DOCSP-37618: Usage Examples landing page (#2767)
Browse files Browse the repository at this point in the history
* DOCSP-37618: Usage Examples landing page

* fix refs

* update TOC

* format fix

* CC feedback

* remove info

* add back

* typo

* CC feedback 2

* add section toc

* feedback, removing tabs

* workflow file

* edits

* fix

* more CC feedback

* run -> use

* changes to running instructions

* turn back into steps

* small fixes

* more reworking

* reword

* reworking

* feedback

* newline

* remove file

* edits

* fix
  • Loading branch information
norareidy authored Apr 3, 2024
1 parent 860dfaf commit 9a616f9
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 2 deletions.
9 changes: 8 additions & 1 deletion docs/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Laravel MongoDB
:maxdepth: 1

/quick-start
/usage-examples
Release Notes <https://github.com/mongodb/laravel-mongodb/releases/>
/retrieve
/eloquent-models
Expand Down Expand Up @@ -47,10 +48,16 @@ Learn how to add {+odm-short+} to a Laravel web application, connect to
MongoDB hosted on MongoDB Atlas, and begin working with data in the
:ref:`laravel-quick-start` section.

Usage Examples
--------------

See fully runnable code examples and explanations of common
MongoDB operations in the :ref:`laravel-usage-examples` section.

Fundamentals
------------

To learn how to perform the following tasks by using the {+odm-short+},
To learn how to perform the following tasks by using {+odm-short+},
see the following content:

- :ref:`laravel-fundamentals-retrieve`
Expand Down
2 changes: 1 addition & 1 deletion docs/quick-start/view-data.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. laravel-quick-start-view-data:
.. _laravel-quick-start-view-data:

=================
View MongoDB Data
Expand Down
68 changes: 68 additions & 0 deletions docs/usage-examples.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
.. _laravel-usage-examples:

==============
Usage Examples
==============

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: set up, runnable

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

Overview
--------

Usage examples show runnable code examples to demonstrate frequently used MongoDB
operations. Each usage example includes the following components:

- Explanation of the MongoDB operation
- Example code that you can run from an application controller
- Output displayed by the print statement

How to Use the Usage Examples
-----------------------------

To learn how to add a usage example to your Laravel application and view the expected output,
see the following sections:

- :ref:`before-start`
- :ref:`run-usage-examples`

.. _before-start:

Before You Get Started
~~~~~~~~~~~~~~~~~~~~~~

You can run the usage examples from your own Laravel application or from the
``{+quickstart-app-name+}`` application created in the :ref:`laravel-quick-start` guide.

The usage examples are designed to run operations on a MongoDB deployment that contains
the MongoDB Atlas sample datasets. Before running the usage examples, ensure that you load
the sample data into the MongoDB cluster to which your application connects. Otherwise, the
operation output might not match the text included in the ``{+code-output-label+}`` tab of
the usage example page.

.. tip::

For instructions on loading the sample data into a MongoDB cluster, see
:atlas:`Load Sample Data </sample-data>` in the Atlas documentation.

.. _run-usage-examples:

Run the Usage Example
~~~~~~~~~~~~~~~~~~~~~

Each usage example page includes sample code that demonstrates a MongoDB operation and prints
a result. To run the operation, you can copy the sample code to a controller endpoint in your
Laravel application.

To view the expected output of the operation, you can add a web route to your application that
calls the controller function and returns the result to a web interface.

1 comment on commit 9a616f9

@GromNaN
Copy link
Member

@GromNaN GromNaN commented on 9a616f9 Apr 3, 2024

Choose a reason for hiding this comment

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

@norareidy You can reword the commit message when merging. The list of commit messages is not meaningful.

Please sign in to comment.