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

docs: add user facing documentation for real-time logs #1963

Merged
merged 28 commits into from
Feb 9, 2022

Conversation

Aayyush
Copy link
Contributor

@Aayyush Aayyush commented Dec 29, 2021

No description provided.

@Aayyush Aayyush requested a review from a team as a code owner December 29, 2021 18:07
@chenrui333 chenrui333 changed the title Added User facing documentation for real-time logs docs: add user facing documentation for real-time logs Dec 30, 2021
chenrui333
chenrui333 previously approved these changes Dec 30, 2021
Copy link
Contributor

@nishkrishnan nishkrishnan left a comment

Choose a reason for hiding this comment

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

This is a pretty huge feature so kind a surprised that we're only adding two lines to the documentation. Would like a bit more here in addition to screenshots as well.

Eventually we should also update the homepage: https://www.runatlantis.io/ but we can do that once we're sure this feature is stable and people are using it.

runatlantis.io/guide/testing-locally.md Outdated Show resolved Hide resolved
@chenrui333
Copy link
Member

This is a pretty huge feature so kind a surprised that we're only adding two lines to the documentation. Would like a bit more here in addition to screenshots as well.

Eventually we should also update the homepage: https://www.runatlantis.io/ but we can do that once we're sure this feature is stable and people are using it.

Make sense. We can add top level tab for the streaming logs functionality.

@chenrui333 chenrui333 dismissed their stale review December 30, 2021 16:08

Need more detailed documentation of the new feature.

@chenrui333 chenrui333 marked this pull request as draft January 17, 2022 22:17
@chenrui333
Copy link
Member

moved the PR to draft mode

@Aayyush Aayyush marked this pull request as ready for review January 20, 2022 18:29
runatlantis.io/logs/README.md Outdated Show resolved Hide resolved
runatlantis.io/logs/README.md Outdated Show resolved Hide resolved
runatlantis.io/logs/README.md Outdated Show resolved Hide resolved
runatlantis.io/guide/testing-locally.md Show resolved Hide resolved
@nishkrishnan nishkrishnan merged commit bbd539b into runatlantis:master Feb 9, 2022
@nishkrishnan nishkrishnan deleted the lyft/add-log-streaming-docs branch February 9, 2022 18:44
krrrr38 pushed a commit to krrrr38/atlantis that referenced this pull request Dec 16, 2022
)

* Added user facing documentation

* Apply suggestions from code review

Co-authored-by: Nish Krishnan <nishkrishnan@users.noreply.github.com>

* Adding top level navigation

* Adding content

* Removing unnecessary artifacts

* Remooving package-loc

* Apply suggestions from code review

Co-authored-by: Nish Krishnan <nishkrishnan@users.noreply.github.com>

* Addressed comments

* Fixing website link error

* Noop commit

* Noop

* Removing link

* Added user facing documentation

* Apply suggestions from code review

Co-authored-by: Nish Krishnan <nishkrishnan@users.noreply.github.com>

* Adding top level navigation

* Adding content

* Removing unnecessary artifacts

* Remooving package-loc

* Apply suggestions from code review

Co-authored-by: Nish Krishnan <nishkrishnan@users.noreply.github.com>

* Addressed comments

* Fixing website link error

* Noop commit

* Noop

* Removing link

* Adding link

* Remove unused assets

Co-authored-by: Nish Krishnan <nishkrishnan@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants